📔

Obsidian Textlint pluginを作りました

2022/12/14に公開約3,000字

みなさんObsidianは使っていますか? obsidianはMarkdownなメモアプリケーションですが、textlintが動けばなぁと思っていた人に朗報?です。

textlintでの文章校正が当たり前になってしまうと、自動校正してくれないソフトに乗り換えるのはどうしても考えてしまうのですが、今後obsidianを使ってみたかったのでプラグインを作成しました。

shivase/obsidian-textlint

動作イメージ

仕事ではNotionを使っているので、そちらのchrome拡張とどちらを作ろうか悩んで、Obsidianはpluginで気軽に作れそうだったのでtexlint開発の練習で作った次第です。

まだ知ったばかりで全然初心者の域を出ていないため、機能として不十分なところが多々あると思いますがご了承ください。

使ってみて、こういう機能があるとよいなだったり、こうしてほしいなどありましたら、issueDiscussionに気軽にコメントをください。

機能の紹介

機能としてはtextlintが吐き出すエラーを表示するだけになっています。推奨値への変更やエラーを無視するなどの対応はまだできていません。

インストールしているtextlint plugin達

GitHubのREADMEにも書いていますが、現在以下がデフォルトで動作するようになっています。
これは今この記事を執筆しているvisual studio codeの環境で利用しているプラグインをそのまま導入したものになります(一部ローカルファイルを使用するプラグインは動作しなかったので除外)。

設定を変えたい場合

Textlintの設定画面を作っており、textlintrc.json を流し込めるようにしています。
上記プラグインの設定しか反映できないですが、使っているtextlintrcが動作しますのでご利用ください。

インストール方法

README.mdに記載していますが、コミュニティプラグインとしてまだ登録されていないので、pluginから検索してもまだ出てきません。

必要な資材をVaultのプラグイン配下に置きリロードしてください。

コミュニティプラグインへの登録は、一部修正必須なコードがあるので、それに対応してからになります。

最後に

実際に使う中での、ご意見や要望などありましたら気軽にコメントください!
私はヘビーユーザーではないため、利用している人のフィードバックを歓迎しています。

GitHubで編集を提案

Discussion

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