よくある質問
バグを発見しました。どうしたらよいですか?
ご利用ありがとうございます。まずは直近のマークアップでお困りのはずで、そこを解決したいでしょう。
**すぐにできることは、そのルールを無効にすることです。**部分的な問題であれば、セ レクタを使いながら部分的に無効化することをおすすめします。そうすることで、他のバグが発生していない箇所は有効のままMarkuplint自体は利用を継続できます。
バグ報告はそのあとでも結構です。Issueを作ってもらうのが確実ですが(日本語で構いません)、作者のTwitterにDMを送ったり、「Markuplint」を含んでツイートしてもらえば拾いに行きます。ぜひバグの修正と機能改善にご協力ください。
どう考えてもおかしくないのに警告がでます
バグの可能性が大いに高いですが、その前に確認していただきたいことがあります。
- 改行コードがCRLFになっている #31
- サポートが間に合っていない構文を使っている #240
これらは既知の問題ですが、現在のところ対応が難航しています。申し訳ありませんが、部分的にルールの無効化をしてください。
上記以外の問題を発見したら、ご報告ください。
初心者ですが使っても大丈夫ですか?
大丈夫です。初学者こそ利用していただきたいです。しっかりと活用しようとするとNode.jsとコマンドの知識が必要になってしまいますが、VS Codeであれば拡張機能をインストールするだけですぐに利用できます。また、単純に試したいだけであればプレイグラウンドサイトがありますので、お気軽にお試しください。
Markuplintはアクセシビリティチェッカーとして機能しますか?
一部機能しますが、すべてのチェックはできません。Markuplintがサポートするのは主に次のとおりです。
- HTMLやSVG、WAI-ARIAが仕様に準拠しているかどうか
- コード上で静的に発見しうるアクセシビリティの問題
- 設定したプロジェクトのルールに則っているかどうか
アクセシビリティはコードに関わること以外にも、情報設計に関わること、ビジュアルデザインに関わること、そもそもコンテンツや戦略の段階から問題が生まれることがあります。ただ少なくともコードに関わることだけはMarkuplintが担うことで、その他の問題解決に取り組む余裕を生み出すことを期待しています。
HTMLHintやeslint-plugin-jsx-a11yと何が違うの?
できることのいくつかは共通するものがありますが、Markuplintとの大きな差としては次のことが挙げられます。
- 要素の親子関係(構造)の適合性チェックができること
- 強力なセレクタ機能によって細かくルールを制御できること
- HTMLやJSX以外の構文を多くサポートしていること
もちろんHTMLHint、eslint-plugin-jsx-a11y、それぞれにしかできないこともあり、どれも導入して併用できますので、適宜プロジェクトにあった利用をしていただけると嬉しいです。