マニュアルの校正作業ツライのでVSCodeにtextlint入れた

そのままですが、なぐり書き。18日目は「レガシーのメンテばかりは嫌だ」と言う学生さんへのマジレス も書いているので合わせてご覧くださいませ。

書くのは好きだけど人の書いたものの読むだけってツライ、と思ったので入れたVSCodeとtextlint。

たすけてドラえもん

WindowsのVS Codeでtextlintを使ってリアルタイムに文章校正する。 があるよ。
Node.js / npmをインストールする(for Windows) をみてインストールします。

npm install -global textlint textlint-rule-preset-ja-technical-writing textlint-filter-rule-comments textlint-filter-rule-whitelist

打てばOK。
色々ぶっ壊すと嫌なので階層を作って

C:\workspaces\textlint

main.md を配置

C:\workspaces\textlint>textlint --init
.textlintrc is created.

.textlintrc を以下のように編集

{
  "filters": {
      "comments": true
  },
    "rules": {
        "preset-ja-technical-writing": true
    }
}

textlint main.md と打ってみると、コマンド上でもエラーが見られます。

もう一息

あとは、VSCode 上から textlint のチェックを実行するために拡張機能をインストールします。
vscode-textlint - Visual Studio Marketplace

インストール後 VSCode を再起動し、作成したプロジェクトを開くことで textlint が有効になります。

Ctrl + Shift + V で、
Visual Studio Code で Markdown リアルタイムプレビュー機能を使える

Enjoy!

image.png
目視の助けくらいにはなるかも。

e99h2121
2003年新卒入社した「人事給与システムのリーディングカンパニー」でへたこきながら開発をしています。2016aug生まれ娘、2018oct生まれ息子に精神を鍛えられている日々
http://e99h2121.github.io/
works-hi
「はたらく」を楽しく!に向けて大手企業の人事業務から変えていく HR業界のリーディングカンパニー
https://www.works-hi.co.jp/
ユーザー登録して、Qiitaをもっと便利に使ってみませんか。
  1. あなたにマッチした記事をお届けします
    ユーザーやタグをフォローすることで、あなたが興味を持つ技術分野の情報をまとめてキャッチアップできます
  2. 便利な情報をあとで効率的に読み返せます
    気に入った記事を「ストック」することで、あとからすぐに検索できます
ユーザーは見つかりませんでした