Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSON Schema #14

Merged
merged 10 commits into from
Feb 17, 2024
Merged

Add JSON Schema #14

merged 10 commits into from
Feb 17, 2024

Conversation

xymopen
Copy link
Contributor

@xymopen xymopen commented Jan 18, 2024

Save the output JSON Schema for editors auto completion if possible. The $schema URL should be available after merging this PR.

"prerun-linter": "yarn run build-ts",
"run-linter": "node dist/index.js",
"pregen-schema": "yarn run build-ts",
"gen-schema": "node dist/bin/genSchema.js"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you mention in the linter README about this command? otherwise lgtm

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually they are not real linter commands. They just allow us to run yarn run-linter without have to run yarn built-ts first. npm would run pre<script> before and post<script> after run <script> command (See the docs) and classic yarn inherits this benhaviour.
Alternative we can use ts-node to achieve the same goal.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The linter README doesn't seem to be the right place to host gen-schema as it is meant to be run by the repository owner. Any ideas?

Copy link
Member

@KTachibanaM KTachibanaM Feb 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a ok place to put linter related code. Repo authors will mostly interact with the root dir anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. I have updated the doc.

@KTachibanaM KTachibanaM merged commit 6970f14 into cloud-emoticon:master Feb 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants