Skip to content

Add Vale for linting prose #67

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
razekmh merged 4 commits into from
Jun 17, 2025
Merged

Add Vale for linting prose #67

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e9c954
Remove weird line endings
paddyroddy Jun 10, 2025
660a462
Add Vale to the repo
paddyroddy Jun 10, 2025
aea3749
Apply Vale fixes to text
paddyroddy Jun 10, 2025
a2013ce
Merge branch 'main' into vale
razekmh Jun 17, 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
5 changes: 5 additions & 0 deletions .github/workflows/linting.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,8 @@ jobs:
- uses: paddyroddy/.github/actions/linting@232a2f3869501abb249d50e311179f98830c6481 # v0
with:
pre-commit-config: ./.pre-commit-config.yaml

# yamllint disable-line rule:line-length
- uses: paddyroddy/.github/actions/vale@d5aea086eaabccae4bcf39786ad5138b629755a6 # v0
Comment thread
paddyroddy marked this conversation as resolved.
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
!.github/styles/config/
!.github/styles/config/vocabularies/
!.github/styles/config/vocabularies/Base
.github/styles/*
.github/styles/config/*
.github/styles/config/vocabularies/*
30 changes: 30 additions & 0 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
StylesPath = .github/styles

# https://github.com/errata-ai/packages
Packages = proselint,\
write-good

[formats]
twee = md
Comment on lines +7 to +8
Copy link
Copy Markdown
Member Author

@paddyroddy paddyroddy Jun 10, 2025

Choose a reason for hiding this comment

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

Not really sure what is best to do here. Vale has a section in the docs of file formats https://vale.sh/docs/formats/front-matter, we don't even need to have one (although some features won't work if we don't). Ideally .twee would be close to one of them, but I'm not sure if it is?


[*.{md,twee}]
BasedOnStyles = proselint,\
Vale,\
write-good

# Disable
Vale.Spelling = NO
write-good.E-Prime = NO
write-good.Passive = NO
write-good.TooWordy = NO

# Ignore lines starting with GitHub alerts syntax
BlockIgnores = (?s)> \[!(CAUTION|IMPORTANT|NOTE|TIP|WARNING)\](\n|$)

# `vale sync` in CI means the packages are then linted, so turn them off
[.github/styles/**]
BasedOnStyles =

# Don't modify generated files
[**/{CODE_OF_CONDUCT,LICENSE}*]
BasedOnStyles =
10 changes: 5 additions & 5 deletions story/choose-a-database.twee
View file
Open in desktop
Comment thread
paddyroddy marked this conversation as resolved.
Comment thread
paddyroddy marked this conversation as resolved.
Comment thread
paddyroddy marked this conversation as resolved.
Comment thread
paddyroddy marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,16 @@ Can you structure your data well in rows and columns?


:: explore-no {"position":"1325,825","size":"100,100"}
But you said you didn't know what questions to ask!
You said you didn't know what questions to ask!

If you know your wishes, [[ask the genie|question-yes]]!



:: explore-yes {"position":"1325,925","size":"100,100"}
You put the lamp in your pack and continue down the road. After some time you arrive at a watering hole. There is a friendly looking elephant drinking, and a dolphin pops its head above the water.
You put the lamp in your pack and continue down the road. After some time you arrive at a watering hole. A friendly looking elephant is drinking, and a dolphin pops its head above the water.

...choose a <a href="https://en.wikipedia.org/wiki/Relational_database">relational DB</a>.
…choose a <a href="https://en.wikipedia.org/wiki/Relational_database">relational DB</a>.

Popular choices: Postgres and MySQL.

Expand Down Expand Up @@ -124,7 +124,7 @@ Is your data media files? (Video, pictures, PDFs, specialised formats like nifti

:: network-yes {"position":"1050,1050","size":"100,100"}
The wizard calls his familiar, a large fuzzy spider. It hands you a magical spider web which speeds up the process of cataloguing the spells.



Copy link
Copy Markdown
Member Author

@paddyroddy paddyroddy Jun 10, 2025

Choose a reason for hiding this comment

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

VSCode didn't like this line ending

Consider using a <a href="https://en.wikipedia.org/wiki/Graph_database">Graph database</a>.


Expand Down Expand Up @@ -179,7 +179,7 @@ Do you know exactly what question to ask? (For example, how many students have a


:: text-no {"position":"900,1475","size":"100,100"}
You find a mysterious map in the library. After following it, you arrive at a watering hole. There is a friendly looking elephant drinking, and a dolphin pops its head above the water.
You find a mysterious map in the library. After following it, you arrive at a watering hole, where a friendly looking elephant is drinking and a dolphin pops its head above the water.

Use a <a href="https://en.wikipedia.org/wiki/Relational_database">relational database</a>. Popular choices: <a href="https://en.wikipedia.org/wiki/PostgreSQL">Postgres</a> and <a href="https://en.wikipedia.org/wiki/MySQL">MySQL</a>.

Expand Down