textlint の導入 #238
Merged
textlint の導入 #238
+3,314
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
takaram
force-pushed
the
textlint
branch
2 times, most recently
from
d7f73d2 to
e3dfcf9
Compare
KentarouTakeda
force-pushed
the
textlint
branch
from
6c30103 to
503c93c
Compare
KentarouTakeda
approved these changes
Jan 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
textlintを導入し、CIで実行します。
Closes #71
モチベーション
約2年前に #69 でtextlintの導入が提案され「メンテナが増えたら検討」となっていました。
ここ数ヶ月でメンテナ・PR作成者も増えており、実際に表記揺れも発生している（#223 など）現状を鑑みて、textlintの必要性が高まっていると感じます。
実装方針
buildディレクトリ以下にpackage.jsonや設定ファイルを配置しています。#71 の"活用例"のブログでも紹介されている textlint-rule-preset-japanese などの導入も検討しましたが、一番の目的は表記揺れ対策のため、今回は textlint-rule-prh のみを導入しています。
build/prh.ymlは、README_Glossary.mdに記載の用語の中から、textlint-rule-prh で対応できそうなもののみ設定しています。textlintは、デフォルトではXML文書に非対応です。XML (DocBook) に対応させるにはプラグインの自作が必要そうで、現実的でないため、PhDでHTMLに変換したものを対象に実行しています。
これの実現のため、CIではXHTML形式のビルド成果物をアーティファクトに保存しています。結果的に #193 (comment) の提案と同じことをしています。