No description or website provided.
TypeScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
image
samples
simpletypochecker
.gitignore
LICENSE
README.md

README.md

SimpleTypoChecker

これは何

主にVSCode向けの表記ゆれ検出を行う拡張機能です。
診断機能とクイック修正機能も実装しました。

表記ゆれがひどいので自分で使うことを用途にざっと作ってみました。

拡張機能のインストール方法

  1. GitHubのリリースページからvsixをダウンロード
  2. code stc.vsix

使い方

  1. 拡張機能をインストール
  2. 設定ファイルを設置
  3. VSCodeのユーザー設定の末尾に設定ファイルへのパスを追加
    "simpletypochecker.grammer": "/path/to/setting.json"
  4. コマンドパレット(Ctrl/Command+Shift+P)からSTC: Enable document checkerを実行
    • この状態で保存時ドキュメント切替時に自動で検証が行われる
    • 手動で検証を起動したい場合、コマンドパレットからSTC: Check the current documentを実行
    • 起動中は左下にステータスが表示される
  5. 終了するにはVSCodeを終了するか、STC: Disable document checkerを実行

設定ファイルの書き方

[
    {
        "mode": 0,
        "severity": 3,
        "pattern": "ウインドウ",
        "arg": "",
        "message": "ウインドウは表記ゆれです。",
        "suggestion": "ウィンドウ"
    },
    {
        "mode": 1,
        "severity": 2,
        "pattern": "Microsoft",
        "arg": "",
        "message": "Microsoftは米Microsoftと表記してください。",
        "suggestion": "米Microsoft"
    },
    {
        "mode": 2,
        "severity": 1,
        "pattern": "エディタ",
        "arg": "",
        "message": "エディタは長音をつけてください。",
        "suggestion": "エディター"
    }
]

mode

  • 0 : 部分文字列の完全一致検索。patternの文字列を見つけ次第出力します。
  • 1 : 前方の表記ゆれ検索(?)。(例えば「Microsoft」を検索して「米Microsoft」にしたい場合など)
  • 2 : 後方の表記ゆれ検索(?)。(例えば「エディタ」を検索して「エディター」にしたい場合など)

severity

  • 0 : Hint
  • 1 : Information
  • 2 : Warning
  • 3 : Error

pattern

  • 文字列もしくは正規表現

arg

  • mode12のときのみ使用。文字列もしくは正規表現

message

  • エディタに表示するメッセージ

suggestion

  • 修正可能な場合は修正後の文字列。空白の場合はクイックアクション(電球マーク)を表示しません。

そのほか

  • 詳細なスキーマはtypings/simpletypochecker/grammer.d.tsを参照

TODO

  • プロジェクトごとに異なるgrammerを読み込めるように挙動を調整