wdl icon indicating copy to clipboard operation
wdl copied to clipboard

feat: double_quotes

Open simojoe opened this issue 9 months ago • 0 comments

This pull request adds a new rule to wdl.

  • Rule Name: double_quotes
  • Rule Kind: Lint warning
  • Rule Code: v1::W012
  • Packages: wdl-grammar

Warns about strings defined with single-quotes. This ignores anything located inside the command section. Tests are not exhaustive, there are quite a lot of things that are using strings. Should they still be added?

Before submitting this PR, please make sure:

  • [X] You have added a few sentences describing the PR here.
  • [ ] You have added yourself or the appropriate individual as the assignee.
  • [ ] You have added at least one relevant code reviewer to the PR.
  • [X] Your code builds clean without any errors or warnings.
  • [X] You have added an entry to the relevant CHANGELOG.md (see "keep a changelog" for more information).
  • [X] Your commit messages follow the conventional commit style.
  • [ ] Your changes are squashed into a single commit (unless there is a really good, articulated reason as to why there should be more than one).

Rule specific checks:

  • [X] You have added the rule as an entry within the the package-specific rule tables (wdl-ast/src/v1.rs for AST-based rules and wdl-grammar/src/v1.rs for parse tree-based rules).
  • [X] You have added the rule as an entry within the the global rule table at RULES.md.
  • [X] You have added the rule to the appropriate fn rules().
    • Validation rules added to wdl-ast should be added to fn rules() within wdl-ast/src/v1/validation.rs.
    • Lint rules added to wdl-ast should be added to fn rules() within wdl-ast/src/v1/lint.rs.
    • Validation rules added to wdl-grammar should be added to fn rules() within wdl-grammar/src/v1/validation.rs.
    • Lint rules added to wdl-grammar should be added to fn rules() within wdl-grammar/src/v1/lint.rs.
  • [ ] You have added a test that covers every possible setting for the rule within the file where the rule is implemented.
  • [X] You have run wdl-gauntlet --save-config to ensure that all of the rules added/removed are now reflected in the baseline configuration file (Gauntlet.toml).

simojoe avatar May 23 '24 12:05 simojoe