From add868684923097ec763bc769444695d38ffef77 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 7 Jul 2026 18:04:37 +0200 Subject: [PATCH 1/3] Add vale and textlint --- .github/workflows/lint.yaml | 49 +++++++++++++++++++++++++++++++++++++ .textlintrc.json | 5 ++++ .vale.ini | 9 +++++++ package.json | 11 +++++++++ 4 files changed, 74 insertions(+) create mode 100644 .github/workflows/lint.yaml create mode 100644 .textlintrc.json create mode 100644 .vale.ini create mode 100644 package.json diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..d7dd674 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -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 ci + - 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 diff --git a/.textlintrc.json b/.textlintrc.json new file mode 100644 index 0000000..802decf --- /dev/null +++ b/.textlintrc.json @@ -0,0 +1,5 @@ +{ + "rules": { + "common-misspellings": true + } +} diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..ce34bca --- /dev/null +++ b/.vale.ini @@ -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 diff --git a/package.json b/package.json new file mode 100644 index 0000000..0584dd9 --- /dev/null +++ b/package.json @@ -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 \"en/**/*.md\"" + } +} From b0631ba89c5ca94d33313bdc1e839941b8840f32 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 7 Jul 2026 18:11:38 +0200 Subject: [PATCH 2/3] Update lint.yaml --- .github/workflows/lint.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index d7dd674..34336c0 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -32,7 +32,7 @@ jobs: with: node-version: 22 - name: Install dependencies - run: npm ci + run: npm install - name: textlint run: npm run textlint vale-lint: From 648e74585719a9041fdc3396dbc4b7840a07dfbb Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 7 Jul 2026 18:13:54 +0200 Subject: [PATCH 3/3] Fix path --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0584dd9..bd8d2dc 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,6 @@ "textlint-rule-common-misspellings": "^1.0.1" }, "scripts": { - "textlint": "textlint -f github \"en/**/*.md\"" + "textlint": "textlint -f github \"**/*.md\"" } }