Allow $schema in JSON configuration file

[AdamVig]

Description

The $schema property can be used by editors to provide inline
documentation and validation in JSON files (see VS Code's
documentation
as an example).

Currently, the JSON schema for the dclint configuration file does
not allow $schema, so adding it causes a configuration validation
error and prevents the tool from starting.

This adds $schema to the configuration JSON schema and documents how
to use it.

Type of Change

• Bug fix
• New feature
• Breaking change
• Refactoring
• Documentation update
• Other (please describe):

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[zavoloklom]

Hi @AdamVig!
Thank you for your PR! It seems very useful!
Could you please change commit message to "feat: allow $schema in JSON configuration file" to match our commit convention.
I also added pre-commit hook with commitlint to make it easy in the future.

[AdamVig]

Hi @AdamVig! Thank you for your PR! It seems very useful! Could you please change commit message to "feat: allow $schema in JSON configuration file" to match our commit convention. I also added pre-commit hook with commitlint to make it easy in the future.

@zavoloklom Thanks for the reminder. I remember seeing this in the documentation and it just slipped my mind. All set now.

[zavoloklom]

@AdamVig Hi again!
Could you please also fix markwownlint warnings? You can check it locally by running: "npm run markdownlint" and you can also try to autofix it with: npm run prettier and npm run markdownlint:fix

[AdamVig]

@AdamVig Hi again! Could you please also fix markwownlint warnings? You can check it locally by running: "npm run markdownlint" and you can also try to autofix it with: npm run prettier and npm run markdownlint:fix

@zavoloklom Hadn't noticed that CI failed, thanks for the callout. Fixed now. The CI pipeline and tooling for this project are great!

[zavoloklom]

@zavoloklom Hadn't noticed that CI failed, thanks for the callout. Fixed now. The CI pipeline and tooling for this project are great!

@AdamVig Thanks! Really glad to hear that.

[zavoloklom]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀