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: implement the PascalCase rule. #90

Merged
merged 6 commits into from
Jun 18, 2024

Conversation

peterhuene
Copy link
Collaborator

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

  • Rule Name: PascalCase

Ensures that struct names use pascal case.

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/v1.rs.
  • You have added a test cases in wdl-lint/tests/lints that covers every
    possible diagnostic emitted for the rule within the file where the rule
    is implemented.
  • 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).

This commit implements the `PascalCase` rule to ensure that struct names use
pascal case.
@peterhuene peterhuene self-assigned this Jun 18, 2024
wdl-lint/src/v1/pascal_case.rs Outdated Show resolved Hide resolved
wdl-lint/tests/lints/pascal-case/source.wdl Outdated Show resolved Hide resolved
Arena.toml Outdated Show resolved Hide resolved
Co-authored-by: Andrew Frantz <andrew.frantz@stjude.org>
Copy link
Member

@a-frantz a-frantz left a comment

Choose a reason for hiding this comment

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

nit picking over the fact the language in PascalCase and SnakeCase weren't exactly mirrored.

wdl-lint/RULES.md Outdated Show resolved Hide resolved
wdl-lint/src/v1/snake_case.rs Outdated Show resolved Hide resolved
@peterhuene peterhuene requested a review from a-frantz June 18, 2024 20:40
Updates `Gauntlet.toml` stjudecloud/workflows SHA to match what's in
`Arena.toml`.
@peterhuene peterhuene merged commit 03a3ac3 into stjude-rust-labs:main Jun 18, 2024
7 checks passed
@peterhuene peterhuene deleted the pascal-case branch June 18, 2024 20:46
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