Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: CI で textlint のエラーを検知できるようにし検知したドキュメントの表現を修正する #1018

Merged
merged 2 commits into from
Mar 22, 2025

Conversation

kudoas
Copy link
Contributor

@kudoas kudoas commented Mar 22, 2025

翻訳・修正

変更内容はCONTRIBUTING.md に記載されたワークフローに従っていることを確認してください。

関連Issue

備考

リポジトリを見ていた時に、CIが期待通り動いていないかも?と気づいたので、提案ベースの PR を送ります。

翻訳のガイドライン では yarn lint により CI が失敗することが期待されていると思いますが、実際には textlint で違反を検知しても step が成功していました。ref. 直近の実行ログ

もしtextlintでエラーが検出されれば、CIで検知され、プルリクエストがmergeできません。
ref. 翻訳のガイドライン

原因はtools/lint.ts では reject: false の設定により textlint で違反を検知しても終了コード0を返してしまうためでした。なので、textlint で違反を検知した場合は終了コード1を返すよう修正しました。 b7a2f6c

また上記の修正の過程で検知したドキュメントの表現も修正しました。 7070a37

参考

  • 変更前の実行結果(終了コード0であることの確認)
yarn lint && echo "終了コード: $status"
yarn run v1.22.22
$ tsx tools/lint.ts
                                                                                                                                                                                                18:39:23
/.../angular-ja/adev-ja/src/content/guide/zoneless.md
  122:7  error  一文に二回以上利用されている助詞 "" がみつかりました。

次の助詞が連続しているため、文を読みにくくしています。

- ""
- ""

同じ助詞を連続して利用しない、文の中で順番を入れ替える、文を分割するなどを検討してください。
  ja-technical-writing/no-doubled-joshi

✖ 1 problem (1 error, 0 warnings)

✨  Done in 26.45s.
終了コード: 0

@kudoas kudoas requested a review from lacolaco as a code owner March 22, 2025 09:52
@lacolaco
Copy link
Collaborator

ありがとうございます!

@lacolaco lacolaco merged commit cdab529 into angular:main Mar 22, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants