build(schema): Add '$schema' property

[caoli5288]

Description

schema.json should allow $schema property

Checklist:

• I have read the Contributing Guide.
• I have updated the documentation accordingly.
• I have updated the tests accordingly.

[rashil2000]

I have thought about this previously.

Pretty useful for autocompleting fields in Neovim, VSCode etc.

[niheaven]

Why define a $shema property in JSON Schema? I mean, what is the purpose of this field in manifest?

[caoli5288]

Why define a $shema property in JSON Schema? I mean, what is the purpose of this field in manifest?

@niheaven Will warn "$schema property not allow here" by VSCode if use this schema explicitly.

[niheaven]

Err, what is the situation of using this schema explicitly? In bucket's .vscode folder, this schema is defined to parse all bucket/*.json, and put $schema at the top of manifest json file is really strange, IMO.

[rashil2000]

Err, what is the situation of using this schema explicitly?

It can help in code autocompletion, and warn about unsupported fields right there in the text editor, which can save time. It's optional anyway, so won't break anything.

In bucket's .vscode folder, this schema is defined to parse all bucket/*.json

Well, not everyone uses VSCode 😉

put $schema at the top of manifest json file is really strange, IMO.

It is the standard practice. Look at Windows Terminal's settings schema, for example: https://raw.githubusercontent.com/microsoft/terminal/release-1.11/doc/cascadia/profiles.schema.json. When you install Windows Terminal for the first time, the settings file already contains these 2 fields:

This helps in easy discoverability of supported features and fields.

[niheaven]

Setting config file that used $schema is acceptable, I thought, but for vast manifests... It's okay for adding it here for some fallback reasons, though I hope it will never be used 🤣

Please modify the title and add changelog item for this PR.

[caoli5288]

Setting config file that used $schema is acceptable, I thought, but for vast manifests... It's okay for adding it here for some fallback reasons, though I hope it will never be used 🤣

Please modify the title and add changelog item for this PR.

@niheaven I make this PR from master branch, so I can't modify the changelog. Maybe you can help me modify it?

[rashil2000]

Your PR is just 4 line change, you can close this and create new one from develop to develop.

[niheaven]

Aha, got it. But you need to revert the recent two commits after this PR is merged in your forked repo.

[rashil2000]

Is Builds the appropriate category here? I'm not so sure.

[niheaven]

I put all schema and bin changes under Builds since this has less CLI changes to end users.