uribo / textlintr

✅ Natural Language Linter Tools for 'R Markdown' and R Code 💯
https://uribo.github.io/textlintr/
Other
8 stars 1 forks source link

Post-install textlint ecosystem #6

Closed uribo closed 5 years ago

uribo commented 5 years ago

Summary

textlintおよびルールの用意

package.json を用意し、init_textlint()を実行することでtextlintならびに事前にいくつかのルールをインストールするようにした。.textlintrというフォルダを作成し、そこに必要なnodeモジュールをインストールする。このフォルダに含まれるファイルはgitバージョン管理には含めない。

https://github.com/uribo/textlintr/blob/8729aaeb5f9edfb688ab2ca05876acd96316add7/R/textlintrc.R#L27-L28

textlintの実行時に利用されるルールを記述した.textlintrcもこのタイミングで作成される。

https://github.com/uribo/textlintr/blob/8729aaeb5f9edfb688ab2ca05876acd96316add7/R/textlintrc.R#L19-L21

package.jsonはパッケージが用意するものなので、ユーザが用意したものを利用できるようにするなどの調整が今後求められる。

ルールの追加

update_lint_rules() によりルールの追加・変更が可能。

適当な文字列を入れてもルールに追加されてしまうので、公式のルール以外は弾くなどの処理が必要。

Windows環境でのテストの不備

5 で報告したようにnpm installができない問題が発生している。

Appveyorでのテストをスキップすることにしてしまい、Windowsでのtextlintを利用する機能のテストができなくなっている。

Related Issues

3 closed