Skip to content

Adding rule for recommendation phrasing #90

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.

Sign up for GitHub

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

Merged
clreaume merged 1 commit into from
Apr 29, 2026
Merged

Adding rule for recommendation phrasing #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions styles/Datadog/recommendations.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# This file is used to lint passive "it is recommended" phrasing.

@iadjivon iadjivon Apr 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

A very meta suggestion for the comment: 😅

  • Use this file to lint passive "it is recommended" phrasing.
  • Lint passive "it is recommended" phrasing using this file.

@clreaume clreaume Apr 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

LOL @iadjivon ! this is such a valid suggestion, especially given the purpose of the file. however, it looks like all the files in https://github.com/DataDog/datadog-vale/tree/main/styles/Datadog have a comment that uses this "This file is used to..." structure. so I will keep it passive for consistency 😭

extends: substitution
message: "Use '%s' instead of '%s'."
ignorecase: true
level: warning
action:
name: replace
swap:
"it(?:'s| is) recommended to": Datadog recommends
Loading