Skip to content

Instantly share code, notes, and snippets.

@azu
Last active March 18, 2016 03:50
Show Gist options
  • Save azu/913454a54ea8ef59ba30 to your computer and use it in GitHub Desktop.
Save azu/913454a54ea8ef59ba30 to your computer and use it in GitHub Desktop.
textlint bug reporting

Bug Reporting

はじめに

textlintをインストールし直したら(アップデートしたら)解決しないか確認して見ましょう。

グローバル(-g)にインストールしている場合

npm uninstall -g textlint
npm install -g textlint

ローカル(-D or -S)にインストールしている場合

rm -fr ./node_modules
# package.jsonがあるなら
npm install 
# package.jsonがないなら
npm install -D textlint

textlintのバージョンは?

textlint -v
# バージョンが出力されます

pacakge.jsonがある場合は、package.jsonもまるごと貼ると良いです。

再現手順

例)

  1. npm install -g textlint
  2. npm install -g textlint-rule-no-todo
  3. 下記のように実行したらエラーがでた
textlint --rule no-todo README.md

Hint ℹ️

DEBUG=textlint*を指定するとデバッグ情報も出力されるので合わせて書いてあると嬉しいです。

DEBUG=textlint* textlint --rule no-todo README.md

対象となるファイル(README.md部分)がどのファイルでも同じエラーになるのか、 それとも特定のファイルだけでエラーになるのかも合わせて書かれていると嬉しいです。

意図した結果

例) ちゃんとLintができる

実際の結果

例) 以下のようなエラーが表示される(全文)

TypeError: Super expression must either be null or a function, not object
...
...

--fix による修正結果が壊れているなら、

textlint --fix --dry-run -f json [file]

で出力したJSON文字列と対象のファイル内容も一緒に書いてみてください。  このJSONによって、textlintのバグなのか、ルールのバグなのかが判定できます。


From https://github.com/textlint/textlint/blob/master/CONTRIBUTING.md#bug-reporting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment