-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add JSON Schema #14
Conversation
"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" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Save the output JSON Schema for editors auto completion if possible. The
$schema
URL should be available after merging this PR.