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

chore: added Vale configuration to validate style guide consistency #1107

Merged
merged 1 commit into from
Jan 4, 2023
Merged

Conversation

themr0c
Copy link
Contributor

@themr0c themr0c commented Jan 4, 2023

What does this PR do?

This pull request is adding Vale configuration to validate style guide consistency and product names using Vale CLI.

The purpose is to ensure compliance and consistency with the Red Hat Style Guide as implemented for Vale. See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/redhat-style-for-vale/

The pull request also introduces a project specific rule to ensure consistent product naming (and associated tests).

This pull request doesn't include GitHub automation. I believe it is too soon to introduce it.

Signed-off-by: Fabrice Flore-Thébault ffloreth@redhat.com

Screenshot/screencast of this PR

Screenshot from 2023-01-04 10-48-04

Screenshot from 2023-01-04 11-01-23

What issues does this PR fix or reference?

How to test this PR?

  1. Install the Vale CLI. See https://vale.sh/docs/vale-cli/installation/.
  2. Synchronize the Red Hat style package
    $ vale sync
    
  3. Run Vale
    $ vale .
    

Optionally, consider integrating Vale into your IDE:

@themr0c themr0c enabled auto-merge (squash) January 4, 2023 11:06
@themr0c
Copy link
Contributor Author

themr0c commented Jan 4, 2023

SonarrLint is reporting warnings on unrelated files:

packages/renderer/src/stores/providers.ts
extensions/podman/src/warnings.ts

How can I fix this?

…nd product names.

Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
@themr0c
Copy link
Contributor Author

themr0c commented Jan 4, 2023

I amended the commit with a new timestamp and repushed the same content. Hope it works.

@themr0c themr0c merged commit 505f852 into containers:main Jan 4, 2023
@podman-desktop-bot podman-desktop-bot added this to the 0.11.0 milestone Jan 4, 2023
@themr0c
Copy link
Contributor Author

themr0c commented Jan 4, 2023

For the record: Vale alerts at this point:

✖ 67 errors, 159 warnings and 516 suggestions in 22 files.

@themr0c themr0c deleted the vale branch January 4, 2023 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants