Skip to content

Test vale on Pull Request. #69

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
wants to merge 19 commits into
base: main
Choose a base branch
from
+11 −10
Open

Test vale on Pull Request. #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
e3a2c82
Test vale on Pull Request.
wmat Apr 22, 2025
1b6d0b2
Fix vale.ini
wmat Apr 22, 2025
5bd7de6
Point at riscv vale rules
wmat Apr 22, 2025
297ebb0
Remove BasedOnStyles
wmat Apr 22, 2025
5cde1d9
Adding back in riscv styles
wmat Apr 22, 2025
f9650ac
Removing BasedOnStyles
wmat Apr 22, 2025
ef67d20
Fixing packages list
wmat Apr 22, 2025
8919f25
Add AsciiDoc package
wmat Apr 22, 2025
16a49d8
Adding RedHat vocab back
wmat Apr 22, 2025
2a7edf7
Fix BasedOnStyles
wmat Apr 22, 2025
d475f64
Update BasedOnStyles
wmat Apr 22, 2025
1505619
Typo maybe?
wmat Apr 22, 2025
e5e4c22
Set .adoc linting
wmat Apr 22, 2025
fd6e7bf
Opening up suggestions
wmat Apr 22, 2025
230357d
typo maybe
wmat Apr 22, 2025
e4318ce
Add AsciiDoc style check back
wmat Apr 22, 2025
6c160e8
Update test
wmat Apr 22, 2025
bc757b4
Set BasedOnStyles again
wmat Apr 22, 2025
f2a50b0
Update .vale.ini
wmat Apr 22, 2025
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
18 changes: 8 additions & 10 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
StylesPath = .github/styles
#MinAlertLevel = suggestion
minAlertLevel = suggestion

#IgnoredScopes = code, tt, img, url, a, body.id
IgnoredScopes = code, tt, img, url, a, body.id

#SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock

#Packages = RedHat
Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip
Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip
#Vocab = riscv-vocab
Packages = RedHat, AsciiDoc, https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip
Vocab = riscv-vocab

#[*.adoc]
#BasedOnStyles = Vale, RISCV-Vale, AsciiDoc
[*.adoc]
BasedOnStyles = Vale, RedHat, riscv, AsciiDoc

#[*.md]
#BasedOnStyles = Vale, RISCV-Vale, AsciiDoc

# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
#TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)

# Match INI files. See: https://docs.errata.ai/vale/scoping
#[*.ini]
Expand Down
3 changes: 3 additions & 0 deletions src/a_few_basics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
== AsciiDoc basics

pseudoinstruction
pseudo-instruction

Check failure on line 5 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L5 

[Vale.Avoid] Avoid using 'pseudo-instruction'.
Raw output 
{"message": "[Vale.Avoid] Avoid using 'pseudo-instruction'.", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 5, "column": 1}}}, "severity": "ERROR"}
Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'pseudo-instruction'.

CSr

Check failure on line 6 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L6 

[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.
Raw output 
{"message": "[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 6, "column": 1}}}, "severity": "ERROR"}

Check failure on line 6 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L6 

[Vale.Spelling] Did you really mean 'CSr'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'CSr'?", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 6, "column": 1}}}, "severity": "ERROR"}
Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'CSr'?

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'CSr'. It is not in the American English spelling dictionary used by Vale.

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[riscv.SpellingRV] Verify the word 'CSr'. It is not in the American English spelling dictionary used by Vale.

Copy link

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[RedHat.PascalCamelCase] Consider wrapping this Pascal or Camel case term ('CSr') in backticks.

Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.

vsr

Check failure on line 7 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L7 

[Vale.Spelling] Did you really mean 'vsr'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'vsr'?", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 7, "column": 1}}}, "severity": "ERROR"}
Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'vsr'?

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'vsr'. It is not in the American English spelling dictionary used by Vale.

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[riscv.SpellingRV] Verify the word 'vsr'. It is not in the American English spelling dictionary used by Vale.

csr

Check failure on line 8 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L8 

[Vale.Spelling] Did you really mean 'csr'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'csr'?", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 8, "column": 1}}}, "severity": "ERROR"}

Check failure on line 8 in src/a_few_basics.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] src/a_few_basics.adoc#L8 

[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.
Raw output 
{"message": "[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.", "location": {"path": "src/a_few_basics.adoc", "range": {"start": {"line": 8, "column": 1}}}, "severity": "ERROR"}
Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'csr'?

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[riscv.SpellingRV] Verify the word 'csr'. It is not in the American English spelling dictionary used by Vale.

Copy link

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'csr'. It is not in the American English spelling dictionary used by Vale.

Copy link

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[riscv.CapitalizeCSR] The acronym CSR must always be capitalized.


AsciiDoc is fully documented, and its documentation is actively maintained. This document contains some information on AsciiDoc markup to get you started.
Copy link

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'has' rather than 'contains'.

Copy link

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'information about' rather than 'information on'.


Expand Down