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

feat: add disallowed input and output name rules #148

Merged
merged 8 commits into from
Jul 31, 2024

Conversation

adthrasher
Copy link
Member

This pull request adds a new rule to wdl-lint.

  • Rule Name: DisallowedInputName
  • Rule Name: DisallowedOutputName

These rules check for prefixes of input and output declarations. They also enforce three or more characters for the declaration identifiers.

Before submitting this PR, please make sure:

  • 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.
  • Your code builds clean without any errors or warnings.
  • You have added an entry to the relevant CHANGELOG.md (see
    ["keep a changelog"] for more information).
  • Your commit messages follow the [conventional commit] style.

Rule specific checks:

  • You have added the rule as an entry within RULES.md.
  • You have added the rule to the rules() function in wdl-lint/src/lib.rs.
  • You have added a test case in wdl-lint/tests/lints that covers every
    possible diagnostic emitted for the rule within the file where the rule
    is implemented.
  • If you have implemented a new Visitor callback, you have also
    overridden that callback method for the special Validator
    (wdl-ast/src/validation.rs) and LintVisitor
    (wdl-lint/src/visitor.rs) visitors. These are required to ensure the new
    visitor callback will execute.
  • You have run wdl-gauntlet --refresh to ensure that there are no
    unintended changes to the baseline configuration file (Gauntlet.toml).
  • You have run wdl-gauntlet --refresh --arena to ensure that all of the
    rules added/removed are now reflected in the baseline configuration file
    (Arena.toml).

@adthrasher adthrasher self-assigned this Jul 31, 2024
@adthrasher adthrasher marked this pull request as ready for review July 31, 2024 16:39
@adthrasher adthrasher requested review from claymcleod, a-frantz and peterhuene and removed request for claymcleod and a-frantz July 31, 2024 16:39
Arena.toml Show resolved Hide resolved
Arena.toml Show resolved Hide resolved
wdl-lint/src/rules/disallowed_input_name.rs Outdated Show resolved Hide resolved
wdl-lint/src/rules/disallowed_output_name.rs Outdated Show resolved Hide resolved
wdl-lint/src/rules/disallowed_output_name.rs Outdated Show resolved Hide resolved
wdl-lint/src/rules/disallowed_output_name.rs Outdated Show resolved Hide resolved
wdl-lint/src/rules/disallowed_output_name.rs Outdated Show resolved Hide resolved
wdl-lint/src/rules/disallowed_output_name.rs Outdated Show resolved Hide resolved
@adthrasher adthrasher merged commit f355241 into main Jul 31, 2024
8 checks passed
@adthrasher adthrasher deleted the feat/disallowed_decl_names branch July 31, 2024 23:04
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