Skip to content

Generating a PR to test Vale. #66

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
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b90cf8f
Generating a PR to test Vale.
wmat Mar 11, 2025
dd26a1d
Fixing up .vale.ini
wmat Mar 11, 2025
f1f5df1
Fix typo
wmat Mar 11, 2025
0d3995f
Set styles name correctly
wmat Mar 11, 2025
fea5c9d
Ignore the styles dir
wmat Mar 11, 2025
0301535
Adding AsciiDoc package.
wmat Mar 24, 2025
0dbcc15
Setting styles path
wmat Mar 24, 2025
c8c9ce1
Setting styles path back.
wmat Mar 24, 2025
ebc1083
Remove styles from gitignore
wmat Mar 24, 2025
d57f653
Mv styles dir into recommended .github dir
wmat Mar 24, 2025
c43d613
Test without the riscv package
wmat Mar 24, 2025
a25de59
Test 2 without riscv package
wmat Mar 24, 2025
56b6598
Add riscv package back
wmat Mar 24, 2025
4de2814
Test
wmat Mar 24, 2025
588af2f
Removing Vale style ref
wmat Mar 24, 2025
d383302
Trying again with riscv package
wmat Mar 24, 2025
75c8202
Move to a single packages line
wmat Mar 24, 2025
637b7c4
Test without riscv style again
wmat Mar 24, 2025
67f21d3
Remove any BasedOnStles values, rely on remote ini file
wmat Mar 24, 2025
81abdfd
remove tokenignores line
wmat Mar 24, 2025
9b0f668
Remove local stylespath
wmat Mar 24, 2025
0f20ad9
Remove Vocab line
wmat Mar 24, 2025
8d27645
Adding vocab
wmat Mar 24, 2025
20b68b4
Remove Vocab
wmat Mar 24, 2025
c15869b
Adding another spelling mistake
wmat Mar 24, 2025
70a15be
Add another spelling mistake
wmat Mar 24, 2025
33f9fe1
Setting the run types
wmat Mar 25, 2025
ef0b451
Adding styles dir to git
wmat Mar 26, 2025
44e55cb
Do I need a space between nested packages
wmat Mar 26, 2025
6349085
Trying with just AsciiDoc package
wmat Mar 26, 2025
61321ac
Remove package, defer to reusable workflow.
wmat Mar 26, 2025
9790b9d
Add packages
wmat Mar 26, 2025
fd0b066
More testing
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
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/riscv-vocab/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pseudoinstruction
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/riscv-vocab/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pseudo-instruction
7 changes: 7 additions & 0 deletions .github/styles/riscv/CapitalizeCSR.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
extends: existence
scope: raw
level: error
message: "The acronym CSR must always be capitalized."
raw:
- '\b(?!(CSR)\b)[cC][sS][rR]\b'
29 changes: 29 additions & 0 deletions .github/styles/riscv/SpellingRV.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#file: noinspection IncorrectFormatting
---
extends: spelling
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
message: "Verify the word '%s'. It is not in the American English spelling dictionary used by Vale."
# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
# Spelling rule applies to individual words
# There is no need to add plural forms (s?) to the regex
filters:
- "[mM]icroarchitecture"
- "[mM]icroarchitectural"
- "IEEE"
- "RISC"
- "RISC-V"
- "IEC"
- "[vV]irtualize"
- "virtualization"
- "SOAR"
- "SPUR"
- "[mM]icrocontroller"
- "FPGA"
- "[pP]seudocode"
- "[hH]alfword"
- "[dD]oubleword"
- "[bB]itwise"
- "[bB]oolean"
- "[sS]box"
- "[eE]ndian"
5 changes: 4 additions & 1 deletion .github/workflows/vale-using-reusable.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Linting with Vale using Reusable Config
#on: [pull_request]
on: [push,pull_request]
on:
pull_request:
types: [opened,edited]
push:

jobs:
call-reusable-vale-workflow-in-riscv-vale-repo:
Expand Down
15 changes: 7 additions & 8 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
StylesPath = styles
StylesPath = .github/styles
#MinAlertLevel = suggestion

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

#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 = 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
#BasedOnStyles = AsciiDoc, riscv

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

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

# Match INI files. See: https://docs.errata.ai/vale/scoping
#[*.ini]
#BasedOnStyles = Vale, RISCV-Vale
#BasedOnStyles = Vale

# Disabling rules (NO)
#RedHat.CaseSensitiveTerms = NO
Expand Down
4 changes: 4 additions & 0 deletions src/a_few_basics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

pseudoinstruction
pseudo-instruction
CsR
cSR
CSR
csr

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

Expand Down