preset-ja-technical-writing・spellcheck-tech-word・preset-ja-spacing・preset-jef-style・prhを導入しています。
5.1K
テクニカルライティングなどの作法にしたがって、README.mdなどの文書を記載できているか確認するためのContainerです。
確認にはtextlintを使用しており、コマンドを入力するとMarkdownファイルの文章の確認ができます。
ここでは、GitLab CIでの活用を前提にして、Containerの使い方を確認します。
以下のツールを導入しております。
| Rule | Description |
|---|---|
| textlint-rule-preset-ja-technical-writing | テクニカルライティングの手法に則っているか確認します。 |
| textlint-rule-spellcheck-tech-word | 技術用語の表記ゆれを防ぐためのルールです。 |
| textlint-rule-preset-ja-spacing | 日本語文章でのスペースの使い方を統一します。 |
| textlint-rule-prh | 表記ゆれの修正に特化したルールです。 |
| textlint-rule-preset-JTF-style | 和訳した文書の表記を統一するためのルールです。 |
GitLabでCIを使うには、初回のみ設定が必要です。「GitLab RunnerでCI/CDしてみる(前編)」を参考にして、CIを使い始める準備をしてください。
CIを使えるようになりましたら、.gitlab-ci.ymlをRepositoryのROOTに作成して、以下のように記述をしてください。
ymlファイルをGitでADDして、GitLabにPushするとREADME.mdの文法チェックが実行されます。
stages:
- textlint
ja-tech-writing:
image: mikohei/textlint:latest
stage: textlint
script: textlint --preset ja-technical-writing README.md
ja-spacing:
image: mikohei/textlint:latest
stage: textlint
script: textlint --preset preset-ja-spacing README.md
tech-word-check:
image: mikohei/textlint:latest
stage: textlint
script: textlint --rule spellcheck-tech-word README.md
jtf-style:
image: mikohei/textlint:latest
stage: textlint
script: textlint --preset textlint-rule-preset-jtf-style README.md
Content type
Image
Digest
Size
210.3 MB
Last updated
almost 6 years ago
docker pull mikohei/textlint