Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 49 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Lint
on:
push:
branches:
- main
pull_request:
workflow_dispatch:
jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: Set up Git repository
uses: actions/checkout@v4
with:
show-progress: ''
- name: markdownlint-cli2-action
uses: DavidAnson/markdownlint-cli2-action@v9
with:
globs: |
**/*.md
#node_modules
textlint:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Set up Git repository
uses: actions/checkout@v4
with:
show-progress: ''
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 22
- name: Install dependencies
run: npm install
- name: textlint
run: npm run textlint
vale-lint:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Set up Git repository
uses: actions/checkout@v4
with:
show-progress: ''
- name: vale
uses: vale-cli/vale-action@v2
with:
fail_on_error: false
5 changes: 5 additions & 0 deletions .textlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"rules": {
"common-misspellings": true
}
}
9 changes: 9 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
StylesPath = .github/styles
MinAlertLevel = suggestion

Packages = write-good

[*.md]
BasedOnStyles = write-good
# E-Prime (flagging every "is"/"are"/"be") is too strict for technical docs.
write-good.E-Prime = NO
11 changes: 11 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "adr.github.io",
"private": true,
"devDependencies": {
"textlint": "^15.7.1",
"textlint-rule-common-misspellings": "^1.0.1"
},
"scripts": {
"textlint": "textlint -f github \"**/*.md\""
}
}
Loading