-
Notifications
You must be signed in to change notification settings - Fork 1k
added vale to CLI #2568
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
Open
sanika-n
wants to merge
26
commits into
projectmesa:main
Choose a base branch
from
sanika-n:cli_update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
added vale to CLI #2568
Changes from 5 commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
112dc4c
added vale prose linter to CI pipeline
sanika-n a8eaab8
finished vale setup
sanika-n cdc94a3
configured vlae to run on push
sanika-n ff46b1b
test to see if vale is working
sanika-n c9ac553
deleted test .md file
sanika-n 1ab114b
suppressed vale to allow the use of 'agent'
sanika-n 9c00478
added testing.md
sanika-n df7fdee
delted ms files
sanika-n 0e7df0f
added ms files again
sanika-n 9e8d900
updated pre-commit
sanika-n ea477ab
deleted a test file
sanika-n dcc756d
modified pre-commit-config
sanika-n 7b318da
test file
sanika-n ced393e
changed vale.yml file
sanika-n 7724441
modified workflow
sanika-n f40435a
edited pre-commit
sanika-n ce498a1
edited pre-commit
sanika-n 911e472
edited pre-commit
sanika-n ffedd3b
edited pre-commit
sanika-n e18625a
edited pre-commit
sanika-n 0790970
delted an unnecessary file
sanika-n 65be4de
corrected repo structure
sanika-n 64286f1
Merge branch 'main' into cli_update
sanika-n 74d4971
added test file to check cli
sanika-n 9a3ac95
deleted a test file
sanika-n 201937e
Update .pre-commit-config.yaml
quaquel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Check Prose with Vale | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- '**/*.md' | ||
push: | ||
paths: | ||
- '**/*.md' # You can specify other file extensions or directories if needed | ||
|
||
jobs: | ||
vale: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Vale | ||
run: | | ||
curl -sSL https://github.com/errata-ai/vale/releases/download/v2.12.0/vale_2.12.0_Linux_64-bit.tar.gz | tar -xz -C /tmp | ||
sudo mv /tmp/vale /usr/local/bin/vale | ||
|
||
- name: Run Vale | ||
run: | | ||
vale . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,3 +32,4 @@ repos: | |
"--ignore-words", | ||
".codespellignore", | ||
] | ||
exclude: .vale/styles/Microsoft/Avoid.yml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
StylesPath = .vale/styles | ||
MinAlertLevel = warning | ||
|
||
[*.md] | ||
BasedOnStyles = Microsoft | ||
|
||
# Do not apply any style to .yml files (by simply not defining a style) | ||
[*.yml] | ||
BasedOnStyles = | ||
|
||
[.vale/**] | ||
BasedOnStyles = | ||
|
||
[.github/**] | ||
BasedOnStyles = | ||
|
||
[.vale/styles/Microsoft/**/*.yml] | ||
BasedOnStyles = | ||
|
||
[*] | ||
BasedOnStyles = |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"Styles": [ | ||
{ | ||
"Name": "Microsoft", | ||
"Path": "https://github.com/errata-ai/vale/tree/master/styles/Microsoft" | ||
} | ||
], | ||
"MinAlertLevel": "warning", | ||
"Extensions": [ | ||
"md" | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
extends: existence | ||
message: Use 'AM' or 'PM' (preceded by a space). | ||
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms | ||
level: error | ||
nonword: true | ||
tokens: | ||
- '\d{1,2}[AP]M' | ||
- '\d{1,2} ?[ap]m' | ||
- '\d{1,2} ?[aApP]\.[mM]\.' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
extends: existence | ||
message: "Don't use language (such as '%s') that defines people by their disability." | ||
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms | ||
level: suggestion | ||
ignorecase: true | ||
tokens: | ||
- a victim of | ||
- able-bodied | ||
- an epileptic | ||
- birth defect | ||
- crippled | ||
- differently abled | ||
- disabled | ||
- dumb | ||
- handicapped | ||
- handicaps | ||
- healthy person | ||
- hearing-impaired | ||
- lame | ||
- maimed | ||
- mentally handicapped | ||
- missing a limb | ||
- mute | ||
- non-verbal | ||
- normal person | ||
- sight-impaired | ||
- slow learner | ||
- stricken with | ||
- suffers from | ||
- vision-impaired |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
extends: conditional | ||
message: "'%s' has no definition." | ||
link: https://docs.microsoft.com/en-us/style-guide/acronyms | ||
level: suggestion | ||
ignorecase: false | ||
# Ensures that the existence of 'first' implies the existence of 'second'. | ||
first: '\b([A-Z]{3,5})\b' | ||
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' | ||
# ... with the exception of these: | ||
exceptions: | ||
- API | ||
- ASP | ||
- CLI | ||
- CPU | ||
- CSS | ||
- CSV | ||
- DEBUG | ||
- DOM | ||
- DPI | ||
- FAQ | ||
- GCC | ||
- GDB | ||
- GET | ||
- GPU | ||
- GTK | ||
- GUI | ||
- HTML | ||
- HTTP | ||
- HTTPS | ||
- IDE | ||
- JAR | ||
- JSON | ||
- JSX | ||
- LESS | ||
- LLDB | ||
- NET | ||
- NOTE | ||
- NVDA | ||
- OSS | ||
- PATH | ||
- PHP | ||
- POST | ||
- RAM | ||
- REPL | ||
- RSA | ||
- SCM | ||
- SCSS | ||
- SDK | ||
- SQL | ||
- SSH | ||
- SSL | ||
- SVG | ||
- TBD | ||
- TCP | ||
- TODO | ||
- URI | ||
- URL | ||
- USB | ||
- UTF | ||
- XML | ||
- XSS | ||
- YAML | ||
- ZIP |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.