flatpak / flatpak-builder

Tool to build flatpaks from source
GNU Lesser General Public License v2.1
139 stars 91 forks source link

[Feature request]: Provide json/yaml schema for manifest file via schemastore.org #555

Open janopae opened 1 year ago

janopae commented 1 year ago

Checklist

Suggestion

This repository maintains a json schema file for Flatpak manifests. This is not only useful to validate manifest files in json or yaml – IDEs can use these files to provide autocompletion.

A lot of IDEs automatically use schema files published at https://schemastore.org. On this website, you can publish schema files for file name patterns. IDEs wil automatically recognise the file name pattern and use the correct schema file to provide autocompletion for json and yaml files that match the pattern.

I propose publishing the json schema from this repo for files called *.flatpak-manifest.yaml/*.flatpak-manifest.json or simply flatpak-manifest.yaml/flatpak-manifest.json. At best, we could automate pushing the schema there when it changes using GitHub Actions.

TingPing commented 1 year ago

Unfortunately there is a ton of convention and tooling that expects $FLATPAK_ID.json. I don't think we should publish anything until we can actually ensure people would even be open to using a new file extension.