Spreadsheet管理のライティングルールをtextlintで浸透させる VSCodeにも適応する

2022/10/05に公開約5,600字

文章を書く際、表記揺れをしないようルールを決めることがあると思います。
その際に共通の定義としてSpreadsheet管理することが多い気はしますが情報が定着せず知らずにレギュレーション違反することもあるでしょう。
この記事は半強制的にルールを浸透させる仕組みとしてtextlintの独自ルールを用いて自分ならこう運用するという記事になります。

サンプル

https://github.com/igara/textlint-custom-rule

ディレクトリ構成としてモノレポ構成な感じでやってます。
実際複数のソースがある場合でも共通のVSCodeの設定を使用したい事が多いので独自のtextlintのプロジェクトもpackagesディレクトリで管理してます。

ファイル説明

導入に必要なファイル説明

.vscode/extensions.json

VSCodeの拡張のvscode-textlintを全員に使用してほしいので追記してます。
VSCode拡張インストール完了したらtextlintをグローバルインストールする必要があります。

npm i -g textlint
.textlintrc.js

textlint設定ファイルです。

    '@textlint/text': {
      extensions: [
        '.php',
        '.ctp',
        '.ts',
        '.tsx',
        '.js',
        '.jsx',
        '.css',
        '.scss',
        '.md',
        '.txt',
        '.csv',
        '.json',
        '.yaml',
        '.yml',
        '.sql',
      ],
    },

textlint適応対象のファイルを指定します。
複雑に言語構文としてではなくテキストとして構文解析させるように@textlint/textを使用しています。

  rules: {
    '@igara/writing-guideline': {
      severity: 'warning',
    },
  },

今回追加するtextlintの独自のライティングルールを指定してます。
@igara/writing-guidelineはnpmに公開しているわけでもなくpackage.jsonにファイルパス指定でインストールさせています。

こちらのファイルを設定することでcliでもtextlint検出が可能になります。

.vscode/settings.json

VSCode上でtextlint適応したいファイルの指定をしています。

  "textlint.languages": [
    "php",
    "html",
    "typescript",
    "typescriptreact",
    "javascript",
    "javascriptreact",
    "css",
    "scss",
    "markdown",
    "plaintext",
    "csv",
    "json",
    "yaml",
    "sql"
  ],

こちらの設定によりVSCodeの編集中でも解析が入るようになります。

textlint独自ルールファイル説明

import.ts

Spreadsheetの内容をwriting.jsonに反映するためのスクリプトです。

このスクリプト実行する前にGoogleのアプリケーションを作成してcredentialのJSONファイルを作る必要があります。

作り方は下記を参考になると思います。
https://developers.google.com/sheets/api/quickstart/nodejs

/**
 * @see https://docs.google.com/spreadsheets/d/${SPREADSHEET_ID}
 */
const SPREADSHEET_ID = '1iYQ3sOOCGFPigtakcpfui0wLUsXwWfqS9TmpUgpiuQY';

を変更すれば他のSpreadsheetからの適応も可能になります。

const SHEET_1 = 'シート1';
const LINT_COLUMN = 'A';
const LINT_COLUMN_ARRAY_INDEX = 0;
//const OK_COLUMN = 'B';
const OK_COLUMN_ARRAY_INDEX = 1;
// const NG_COLUMN = 'C';
const NG_COLUMN_ARRAY_INDEX = 2;
const IGNORE_COLUMN = 'D';
const IGNORE_COLUMN_ARRAY_INDEX = 3;

ここの値はSpreadsheetの行列に依存しますがこんな感じのシートの想定でやってます。

Lint対応 OK NG Ignore 補足
対応中 ください 下さい
対応中 \. [a-zA-Z_0-9]. 英語表記ではないときの文章では「。」に置き換えること

Lint対応列が「対応中」か「済」のときにwriting.jsonに保存対象にしています。
NG, Ignoreの値は正規表現のものを実際のtextlintのルールでは許可しています。
単語の表記揺れ修正の場合は正規表現を使わなくても良さそうですが構文的なものはちょっと考える必要があるなと思いました。

npm run spreadsheet

でinportの実行ができるようにしてます。

writing.json

import.tsで生成されるファイルです。
値のアクセスをしやすいようにNGワードをKayにしています。

{
  "下さい": {
    "ok": "ください",
    "ignore": "",
    "url": "https://docs.google.com/spreadsheets/d/1iYQ3sOOCGFPigtakcpfui0wLUsXwWfqS9TmpUgpiuQY/edit#gid=0&range=2:2"
  },
  "\\.": {
    "ok": "。",
    "ignore": "[a-zA-Z_0-9]\\.",
    "url": "https://docs.google.com/spreadsheets/d/1iYQ3sOOCGFPigtakcpfui0wLUsXwWfqS9TmpUgpiuQY/edit#gid=0&range=3:3"
  }
}

urlも作成したのはVSCode、cliから実際のルールを記載しているリンクへ遷移できたら便利そうなので追加してます。
ここのうまい方法わかっていないのでVSCodeもしくは拡張勉強してみたいというモチベーションがありますね。

index.ts

textlintの独自のルールを実装したファイルです。
writing.jsonの定義から正規表現で頑張って違反してるかやってるコードです。

index.js

index.tsをビルドして生成されたファイルです。

npm run build

でビルドできるようにしています。

index-test.ts

index.tsに対してinvalid.tsx(lintにひっかかる)valid.tsx(lintにひっかからない)文章をテストするコードです。

.vscode/launch.jsonによってデバッグの設定も入れているのでVSCodeのデバッグ機能も有効になっています。

その他伝えたいこと

textlintの独自ルールを作成する際、下記のブログがすごいお世話になりました。

https://someiyoshino.info/entry/2022/07/30/185845

GitHubで編集を提案

Discussion

ログインするとコメントできます