textlintの直し方
textlintの直し方をざっくりとまとめたものです。
- Contributing Guideに一通り書いてます
相談したいことがある場合はGitterに日本語のchatがあるのでそちらを使ってみてください。 (これどうやって直せばいいのとか？)
- 適当な英語が多いので修正歓迎
- ルールの作り方とかもっと具体例のドキュメント増やしたい
- こういうのがわからないというIssueを立てるでもよさそう
- textlintはmonorepoになっているのでtextlintに色々なパッケージが入っています。
- monorepoへの移行が完璧ではないのでそれをなおすのも歓迎です
- Import * to monorepo #270
- 直したいところは色々あるので小さなものでも歓迎
label:"good first issueというラベルが付いてるやつは比較的やることがはっきりしてるので手が出しやすいかも- Use with TypeScript #248とか方針が決まって直せれば、型定義の恩恵をルール作成時に受けられてよさそう
- textlintはデフォルトでルールをもっていません
- そのためすべてのルールはプラグイン扱いです
- ルール一覧はCollection of textlint rule · textlint/textlint Wikiにあります
- 各ルールにPull RequestやIssueを立てるのがよさそうです
- textlint-jaで管理している日本語専用のルールは、日本語が分かる人じゃないと使わないので、Issueなどは日本語で問題ないです
- 歴史的経緯で個人のリポジトリに多くのルールがあります
- 日本語専用のルールはtextlint-jaのorganizationで管理しています
- その他のルールをtextlint-ruleで管理しようかなと考えています
- もっと目的のルールを見つけやすくする方法を模索しています
- textlintのnpmパッケージに"keywords:textlintrule"をつけるルールを導入しています(これも不完全)
- 例) これらを対象にしたBower Search · Bowerのような検索エンジンを作る
- 例) パッケージにあるといいメタデータを考えて既存のルールに追加していく
- 例) 突然ものすごいアイデアを思いついたのでGitterに書き込む
- textlintは自由にルールを書けます
- 📝 ドキュメント: Creating Rules
- 日本語専用のルールはtextlint-ja
- その他のルールはtextlint-rule
- それぞれoranizationも用意してあるので興味がある人は、@azu_reかGitterで言ってもらえれば invite します