Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .github/workflows/docs-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ jobs:
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: "22"
- run: node tools/docs-lint.mjs
- run: npx --yes github:128na/docs-lint#v1.0.0
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ composer run stan # PHPStan
composer run rector # Rector (automated refactoring, dry-run by default)
php artisan test # PHPUnit

composer run docs # docs-lint (node tools/docs-lint.mjs, requires Node.js)
composer run docs # docs-lint (npx github:128na/docs-lint#v1.0.0, requires Node.js)
```

## Architecture
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"@php ./vendor/bin/rector --no-diffs"
],
"docs": [
"node tools/docs-lint.mjs"
"npx --yes github:128na/docs-lint#v1.0.0"
]
},
"extra": {
Expand Down
8 changes: 5 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ドキュメント規約

このリポジトリのドキュメントは「実装とテストが SSOT(唯一の真実)」を前提に、
md として残すものを次の3種類に限定する。この規約は `tools/docs-lint.mjs` で機械検証される。
md として残すものを次の3種類に限定する。この規約は [docs-lint](https://github.com/128na/docs-lint) で機械検証される。

## 原則

Expand Down Expand Up @@ -76,8 +76,10 @@ spec 相当文書を削除する前に:
## 検証

```bash
node tools/docs-lint.mjs
npx --yes github:128na/docs-lint#v1.0.0
```

CI(`.github/workflows/docs-lint.yml`)でも同じものが走る。`composer run docs`(`composer run all` にも
含まれる)からも実行できる。
含まれる)からも実行できる。実体は [docs-lint](https://github.com/128na/docs-lint)
パッケージ(複数リポジトリで共有、タグ `v1.0.0` 固定)。設定ファイルは引き続き
`tools/docs-policy.json`。
181 changes: 0 additions & 181 deletions tools/docs-lint.mjs

This file was deleted.

2 changes: 1 addition & 1 deletion tools/docs-policy.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$comment": "docs-lint.mjs が読む機械可読ポリシー。生きた文書を増やす場合は livingDocs に追記し、理由を ADR として残すこと。",
"$comment": "docs-lint(github:128na/docs-lint)が読む機械可読ポリシー。生きた文書を増やす場合は livingDocs に追記し、理由を ADR として残すこと。",
"scanRoots": {
"recursive": ["docs"],
"flat": ["."]
Expand Down
Loading