notebook

都内でWEB系エンジニアやってます。

VS Codeのスニペットを使いtextlintのdisableを楽に行う

VS Codeで記事を書いていて、textlintでリアルタイムに校正しているが除外したい文言だったり言い回しだったりがある場合、設定で除外する方法の他にMarkdown内でコメントを挿入することで一時的にチェック対象から外せる

文章の癖というか、チェックはしておきたいが除外したいときもあるのでそういうときはコメントで対象箇所を囲うことで一時的にチェック対象から外す運用をしている

textlint.github.io

textlint.github.io

今までは適当なメモ用のファイルによく除外するルールのdisable, enableのコメントを用意して毎度コピー&ペーストしていた

ふとした時に「なんか面倒だなー」と思いスニペットで楽しようと思いつき試してみた

自分は基本的に記事はMarkdownで書くためMarkdownのスニペットに設定を書いた

スニペットの設定方法などについては次の記事に書いてあるので割愛する

Snippets in Visual Studio Code

code.visualstudio.com

よく使う設定だけ書き出してみた

   "textlint-disable-comment-ja-no-weak-phrase": {
        "prefix": "lint-kamo",
        "body": [
            "<!-- textlint-disable ja-technical-writing/ja-no-weak-phrase -->",
            "${TM_SELECTED_TEXT}",
            "<!-- textlint-enable ja-technical-writing/ja-no-weak-phrase -->"
        ],
    "description": "disable ja-technical-writing/ja-no-weak-phrase"
    },
    "textlint-disable-comment-sentence-length": {
        "prefix": "lint-length",
        "body": [
            "<!-- textlint-disable ja-technical-writing/sentence-length -->",
            "${TM_SELECTED_TEXT}",
            "<!-- textlint-enable ja-technical-writing/sentence-length -->"
        ],
    "description": "disable ja-technical-writing/sentence-length"
    },
    "textlint-disable-comment-prh": {
        "prefix": "lint-prh",
        "body": [
            "<!-- textlint-disable prh -->",
            "${TM_SELECTED_TEXT}",
            "<!-- textlint-enable prh -->"
        ],
    "description": "disable prh"
    },

TM_SELECTED_TEXTは現在選択している行を置換してくれる

なので指摘があればその箇所の指摘を見る→除外するならその行を選択してスニペットで除外

という感じの操作で除外できる

やってみたら思った以上に便利だったので記事を書いた

クイックフィックス

蛇足だがクイックフィックスを使える指摘についてはショートカットCtrl+.でFixできる

わざわざクリックする必要がないのでキーボードから手を離さず作業できて良い

こちらも便利だが今まで使っていなかっただけなのでこれを機に意識していく