Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
textlintの直し方

textlintの直し方

textlintの直し方をざっくりとまとめたものです。

相談したいことがある場合はGitterに日本語のchatがあるのでそちらを使ってみてください。 (これどうやって直せばいいのとか?)

Gitter

ドキュメントを直す

  • 適当な英語が多いので修正歓迎

ドキュメントを追加する

  • ルールの作り方とかもっと具体例のドキュメント増やしたい
  • こういうのがわからないというIssueを立てるでもよさそう

コアを直す

  • textlintはmonorepoになっているのでtextlintに色々なパッケージが入っています。
  • 直したいところは色々あるので小さなものでも歓迎
  • label:"good for beginner" というラベルが付いてるやつは比較的やることがはっきりしてるので手が出しやすいかも
  • 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は自由にルールを書けます
  • 日本語専用のルールはtextlint-ja
  • その他のルールはtextlint-rule
  • それぞれoranizationも用意してあるので興味がある人は、@azu_reGitterで言ってもらえれば invite します
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment