Skip to content

Add vale linter to check for errors in text #1018

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

Open
Aviatorscode2 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add vale linter to check for errors in text #1018

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ yarn-error.log*
next-env.d.ts
# clerk configuration (can include secrets)
/.clerk/

.vale/styles
19 changes: 19 additions & 0 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# where styles are saved
StylesPath = .vale/styles/

# the minimum alert level
MinAlertLevel = suggestion

# style guide packages
Packages = Google, write-good

# map MDX files to Markdown since Vale doesn't natively support MDX
[formats]
mdx = md

Vocab = Base


# apply Google and Novu style guide rules to both Markdown (.md) and MDX (.mdx) files
[*.{md,mdx}]
BasedOnStyles = Google, Novu, write-good
Copy link
Member

@jainpawan21 jainpawan21 Dec 7, 2025

Choose a reason for hiding this comment

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

@Aviatorscode2

Could you please share the link of Novu? I could not find here
https://vale.sh/explorer

Copy link
Contributor Author

@Aviatorscode2 Aviatorscode2 Dec 7, 2025

Choose a reason for hiding this comment

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

@jainpawan21, All rules are local for now. I am using Google and write-good rules for now to catch any errors before I commit them. So I need it merged. For now what I need is Google and write-good, while I work on the Novu style guide rules