Obsidian Textlint

README in English is Here

Obsidian 用のtextlintプラグインです。

導入することで、日本語の文章校正を行ってくれます。 (textlint 自体は日本語だけではなく自然言語一般を対象としていますが、現時点では日本語向けの textlint プラグインがメインです)

インストール方法

現時点ではコミュニティプラグインとして登録されていないため、マニュアルでの導入になります。

マニュアルインストール

1. latest release より最新版の zip をダウンロード
2. main.js, styles.css, manifest.json を VaultFolder/.obsidian/plugins/obsidian-textlint/ 配下にコピー (VaultFolder は各自の Vault ディレクトリを指定)
3. Obsidian をリロード

使い方

COMMAND + Pを押してコマンド入力画面を呼び出し、textlintを入力して実行して下さい。

有効化されている textlint のプラグイン

このプラグインで動作する、textlint のデフォルトプラグインは以下の通りです。 @shivase の使っているものを入れているので、あまり万人向けとして精査していません。

• @textlint-ja/no-synonyms
• @textlint-ja/textlint-rule-no-dropping-i
• @textlint-ja/textlint-rule-no-insert-dropping-sa
• abbr-within-parentheses
• footnote-order
• ja-hiragana-keishikimeishi
• no-mixed-zenkaku-and-hankaku-alphabet
• period-in-list-item
• prefer-tari-tari
• preset-ja-spacing
• preset-ja-technical-writing
• preset-jtf-style
• textlint-rule-date-weekday-mismatch
• textlint-rule-ja-no-inappropriate-words
• textlint-rule-ja-no-orthographic-variants
• textlint-rule-use-si-units
• textlint-rule-write-good

後述する本プラグインの設定画面より、各プラグインの有効化・無効化、及び詳細の設定を追加できるようになっています。

設定

現時点の設定できる項目は以下の通り

• Lint on save
  ON にすることで、ファイルの保存時に自動的に Textlint が実行されます
• Folder to ignore
  対象外となるフォルダを設定できます。箇条書きで対象フォルダを記載して下さい
• Override textlintrc
  textlint の設定を上書きたい場合にtextlintrc.json形式で記載して下さい。デフォルト設定とマージ処理されるため、記載の無い項目はデフォルト値が優先されます。
  実際に設定しているデフォルト値はこちら -> textlintrc.json

TODO

• とにかくテスト書く
• textlint が推奨する値に変更するボタンを追加する
• エラーを無視できるようにする
• textlint の設定を json 形式で上書きさせるのではなく、それぞれ個別に ON/OFF できるようにする
• 無理矢理 react 部分をどうにかする
• tooltip の位置が右端にでた時に隠れるのを修正する

Plugin Development

1. cd VaultFolder/.obsidian/plugins/
2. Clone this repo.
3. pnpm to install dependencies
4. pnpm build:dev to build main program
5. pnpm generate-worker:dev to build textlint worker.
   command this after installing textlint plugins or updating scripts/textlintrc.json.

Contact

質問や要望・バグ報告は、気軽に Github issue や Twitter(@shivasek5)の DM 等をご利用下さい。

If you want to support me (shivase) you can support me on Ko-fi