[PSC-2029] Allow configuring the lint command via CLI arguments
#2153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `lint` command can be configured with a `LintConfig`. However, this `LintConfig` is currently hardcoded in `lint.ts` and cannot be changed via command-line arguments. This PR adds the ability to configure the `lint` command in the CLI. This allows running things like: ``` $ spot lint api.ts --has-discriminator=error $ spot lint api.ts --no-nullable-arrays=off ``` The `help` command now returns: ``` $ spot lint api.ts --help Lint a Spot contract USAGE $ spot lint SPOT_CONTRACT ARGUMENTS SPOT_CONTRACT path to Spot contract OPTIONS -h, --help show CLI help --has-discriminator=(error|warn|off) Setting for has-discriminator --has-request-payload=(error|warn|off) Setting for has-request-payload --has-response=(error|warn|off) Setting for has-response --has-response-payload=(error|warn|off) Setting for has-response-payload --no-inline-objects-within-unions=(error|warn|off) Setting for no-inline-objects-within-unions --no-nullable-arrays=(error|warn|off) Setting for no-nullable-arrays --no-nullable-fields-within-request-bodies=(error|warn|off) Setting for no-nullable-fields-within-request-bodies --no-omittable-fields-within-response-bodies=(error|warn|off) Setting for no-omittable-fields-within-response-bodies EXAMPLE $ spot lint api.ts $ spot lint --has-descriminator=error $ spot lint --no-nullable-arrays=off ```
|
|
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description, Motivation and Context
The
lintcommand can be configured with aLintConfig. However, thisLintConfigis currently hardcoded inlint.tsand cannot be changed via command-line arguments.This PR adds the ability to configure the
lintcommand in the CLI.This allows running things like:
The
helpcommand now returns:Checklist: