できること

カーソル位置から上に一番近い見出し(#記法)¹の文字をステータスバーに表示します。

動作例

作った理由

類似機能を探すことが難しかったため。

欲しかった理由

文章ではなく、たとえば人名やタスクなどを見出しでざっくり# 上司, # A社, ## A社営業部などと分類して振り分けていくことがあり、数が多くなると見出しが見えなくなり検索で飛んだときなどにどの属性(見出し)か分からず上にスクロールするケースが出てきた。
管理方法の見直しより対症療法的にこの上スクロールでの確認を省くことにした。

コード

ViewMarkdownHeading.sublime-settings

{
    "target_syntaxs": ["Markdown", "MultiMarkdown"],
    "max_length": 30
}

ViewMarkdownHeading.py

import sublime
import sublime_plugin
import os

class ViewMarkdownHeading(sublime_plugin.ViewEventListener):
    STATUS_KEY = 'md_heading'

    def __init__(self, view):
        super().__init__(view)
        self.ENABLED = False
        self.view.settings().add_on_change('syntax', self.is_target_file)
        self.is_target_file()


# バッファファイルでトリガーしないのでinitに任せる
#    def on_load_async(self):
#        print('on_load_async')

# 実用面で入力≒selectionの移動＝on_selection_modifiedなので、不満が出るまで置いておく
#    def on_modified_async(self):
#        print('mod')
#        self.main()

    def on_selection_modified_async(self):
        self.main()

    def is_target_file(self):
        syntax = os.path.splitext(os.path.basename(self.view.settings().get("syntax")))[0]

        targetSyntaxs = sublime.load_settings('ViewMarkdownHeading.sublime-settings').get('target_syntaxs')
        self.ENABLED = syntax in targetSyntaxs

    def reset_md_heading_key(self):
        self.view.erase_status(ViewMarkdownHeading.STATUS_KEY)

    def set_md_heading_key(self, str):
        self.view.set_status(ViewMarkdownHeading.STATUS_KEY, str[:sublime.load_settings('ViewMarkdownHeading.sublime-settings').get("max_length")])

    def main(self):
        if self.ENABLED == False:
            self.reset_md_heading_key()
            return

        sel = self.view.sel()
        carret = sel[0].begin()
        if carret == 0:
            self.reset_md_heading_key()
            return

        headings =  self.view.find_all('(?m)^#+\s*.*')

        if len(headings) == 0:
            self.reset_md_heading_key()
            return

        for i, heading in enumerate(headings):
            # カーソル位置より下の見出しがあれば、一つ前の見出しに属している
            if heading.begin() > carret:
                if i == 0:
                    self.reset_md_heading_key()
                    break
                self.set_md_heading_key(self.view.substr(headings[i - 1]).lstrip('#').lstrip())
                break
            # 最後まで属してなければ最後の見出しに
            if i + 1 == len(headings):
                self.set_md_heading_key(self.view.substr(headings[i]).lstrip('#').lstrip())

うまぶりポイント

全部のファイルに反応するのではなく(右下で設定する)特定のシンタックスファイルの場合にのみ動作させたかった。
シンタックスは拡張子の自動判定のほか、(特に新規未保存ファイルなどで)開いているファイルのシンタックスを動的に変更することができる。
幸い、Settingsクラスにonchangeイベントがあったのでシンタックスの変更時に処理するべきファイルかを再判定できた。

self.view.settings().add_on_change('syntax', self.is_target_file)

ステータスバーに表示した理由

ミニマップのように恒常的に表示するAPIがなさそうに見えたため。
コマンド呼び出しで一時表示する方法もあったが不精なので常時表示したかった。

シンタックスの判定

self.view.settings().get("syntax")
では
Packages/Markdown/Markdown.sublime-syntax
といったパスで返ってくる。
また拡張子がtmLanguageのものもあり、今回はosモジュールを使ったやや冗長に見えるファイル名の抜き出し方法になった。

見出し判定

正規表現で行っているが、カーソルの真上の見出しを探す関係上、カーソル位置以降のテキストは不要。
しかしAPIではビューに対するfindかfind_allしかないため、全文検索している。
効率よくするならカーソル位置までの文字列を切り出し普通の正規表現で調べるべきだろうが、初めて触ることもありAPIの機能のほうを使用した。

開発プラグインの子ディレクトリ化

新規にプラグインを作る場合はメニューから
Tools -> Developer-> New Plugin
で雛形を作り、そのまま保存すると
(ST3)\Data\Packages\User\
に保存される。
そのまま開発が進み、コンフィグなど複数ファイルを扱うようになると、ディレクトリを切り管理したくなる。
しかし、Userの下にディレクトリを設置してもそのプラグインは読み込まれない。User直下でないと駄目なようだ。
なので、ディレクトリ単位で扱いたい場合はインストールするプラグインと同様にひとつ上、(ST3)\Data\Packages\ に設置するとよい。

Sublime Text 3でプラグインを作るメモ - Qiita#ひな形の生成から実行まで

では省略か最初から (ST3)\Data\Packages\test\ に置くように書かれており、おそらく遅まきに理由を理解した。

メニューからコンフィグファイルへのアクセス

既存のインストール済みプラグインの一部はメニューの
Preferences -> Package Settings -> パッケージ名 ->
からコンフィグファイルにアクセスできる。
しかしコンフィグファイルを作り自作プラグインを読み込んだだけではここには追加されない。
この処理はPackage Controlが管轄していると推測していたが、GitHub経由でのPackage Controlからのインストールでも追加されない。
結局、各プラグインが自主的にこの場所におのおのメニューを追加しているということが分かった。
つまりメニューを追加するMain.sublime-menuファイルだ。

Main.sublime-menu

[
    {
        "id": "preferences",
        "children": [
            {
                "id": "package-settings",
                "children": [
                    {
                        "caption": "ViewMarkdownHeading",
                        "mnemonic": "V",
                        "children": [
                            {
                                "caption": "Settings",
                                "mnemonic": "S",
                                "command": "open_file", "args": {
                                    "file": "${packages}/ViewMarkdownHeading/ViewMarkdownHeading.sublime-settings"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

既存のものからの改変のため[]で始まっているが、{}でもよいようだ。

GitHubからのインストール

Package ControlはGitHubのURLに対応しておらず、URLを入力してもインストールされない。
しかしGitのリポジトリには対応しているため、リポジトリを追加すればインストールの候補に出る。
リポジトリ追加は
Package Contorol: Add repository
から。
https://github.com/khsk/ViewMarkdownHeading.git
などと入力して追加する。
ただPublishしない個人的なローカルな開発ならPackage Controlを経由する利点はさほどないかもしれない。

参考

バックアップ

Python | スライスを使って文字列の指定範囲の部分文字列を取得する Archive
Pythonのクラス変数とインスタンス変数 | UX MILK Archive
How do I call a parent class's method from a child class in Python? - Stack Overflow Archive
Linux SublimeText 3 で自作プラグイン - Qiita Archive
Python | リストに指定した値と同じ要素が含まれているか確認する Archive
Sublime Text API Reference（翻訳） - Qiita Archive
python - Get file syntax selection in sublime text 3 plugin - Stack Overflow Archive
Sublime Text 3でプラグインを作るメモ - Qiita Archive
API Reference – Sublime Text Documentation Archive
Pythonのfor文でインデックスを同時に参照する：enumerate() | UX MILK Archive
sublimetext2 - Sublime Text 3: How to install plugins from Github - Stack Overflow Archive

---や====による見出しには非対応。 ↩

Markdownでカーソル位置の見出し名を表示するSublime Textプラグイン