[Obsidian Plugins] Linter
機能
定められたルールに則って、テキストやフロントマターを整形する。
VSCodeなどのテキストエディタでは、類似の機能が広く一般的に利用されている。
前提
改行の扱い
現在のObsidianは設定 > エディタ > 厳密な改行によって、Enter1つで改行するかマークダウン記法の改行 (行末でスペース×2) に従うかを選択できる。
この設定項目がONのとき、編集モードでの単一のEnter (見た目の改行) は実際には改行として認識されず、パース時に無視される。
前提として、この項目がOFFであると仮定する。
Linterの実行
私的な使い方として、Linterの実行は Ctrl(⌘) + S の明示的なファイルセーブ時に行う。
そのため以下は全てLinterプラグインの設定項目であり、ルールの定義である。
また数が多いので、個人的に利用しているものを中心に掲載する。
各設定項目はマウスオーバーでGitHubの解説ページに飛べる。
より詳しい解説が必要ならそちらを確認。
General Settings
全体的な設定。
Lint on save
ファイル保存時にLinterを実行。
Folders to ignore
ここで指定されたフォルダに含まれるファイルには、Linterを実行しない。
テンプレートファイルには実行してほしくないので、テンプレートフォルダを指定。
YAML tags section style
single-lineでも問題が無い場合はそのままでOK。
特定プラグインに配慮し、multi-lineに変更。
YAML Settings
YAMLフロントマターに関する設定。
Key SortとTimestampは変更しているので、ここだけメモ。
YAML Key Priority Sort Order
指定したキーは並び替えの対象となる。
Priority Keys at Start of YAML
自動並び替えのON/OFF。
Keep track of the date the file was last edited in the YAML
長い。
これをONにしておくと実行時、フロントマターに作成日時と更新日時が自動入力される。
Format
YYYY-MM-DD HH:mm
Content Settings
テキストに関する項目。
Remove Multiple Spaces
連続するスペース (空白) を削除する。
Two Spaces Between Lines with Content
文末にスペースを2つ入力する。
Spacing Settings
改行や空白に関する項目。
Consecutive blank lines
連続する改行を1行開けまでに抑え、それ以上は削除する。
Empty Line Arround ○○
各種要素の上下に空白行を追加する。
Heading blank lines
見出しの上下に空白行を追加する。
Line Break at Document End
ファイル末尾に空白行を追加する。
Paste Settings
主にテキストをペーストした際の挙動。
Custom Settings
Linterを実行した直後にObsidianのコマンドを呼び出したり、正規表現を使用してテキストを置き換えたりできる。
上級者向け。
Debug Settings
出力されるログのレベル設定とログの確認。
通常は触る必要は無い。