outline-to-text README

この VSCode 拡張機能は、VSCodeの「アウトライン」ペインに表示される情報を簡単にテキストファイルとして取得できるようにします。現在のファイル内のメソッド一覧や、ファイル内のすべてのシンボルを素早く取得し、テキストファイルとして保存できます。

機能

現在のファイル内のトップレベルのメソッドと関数の一覧を、「アウトライン」ペインの通りに取得します
現在のファイル内のすべてのシンボル（クラス、メソッド、プロパティなど）を、「アウトライン」ペインの通りにリスト構造で取得します。
- 「並べ替え：位置」と同等にソートされたリストを取得します。
生成された一覧は、未保存のMarkdownファイルとして表示されます

使用方法

VSCode でファイルを開きます
コマンドパレットを開きます（Windows/Linuxの場合はCtrl+Shift+P、Macの場合はCmd+Shift+P）
以下の2つのオプションがあります：
- a. "Get Method Outline" と入力してコマンドを選択すると、トップレベルのメソッド一覧を「アウトライン」ペインの通りに取得します。
- b. "Get All Outline" と入力してコマンドを選択すると、すべてのシンボルを「アウトライン」ペインの通りにリスト構造で取得します。
取得した情報を含む新しい未保存のMarkdownファイルを表示します

出力形式

getMethodOutline

トップレベルのメソッドと関数名のシンプルな一覧を生成します
出力ファイルは [元のファイル名]_トップレベルのメソッド一覧.md という名前になります

getAllOutline

ドキュメント内のすべてのシンボルの階層的なリストを生成します
各行にはシンボルの種類（例：[Class]、[Method]、[Property]）が含まれます
階層構造はMarkdownのリストインデントを使用して表現されます
出力ファイルは [元のファイル名]_シンボル一覧.md という名前になります

getMethodFullPathOutline

ドキュメント内のすべてのシンボルの階層構造から、メソッド[Method]（関数[Function]）のフルパス一覧を生成します。
Markdownのリストフォーマットを使用して表現されます
出力ファイルは [元のファイル名]_メソッドのフルパス一覧.md という名前になります

* [Function] myFunction1
  * [Function] myFunction2
* [Class] myClass1
  * [Method] myMethod1
  * [Class] myClass2
    * [Method] myMethod2
↓
* [Function] myFunction1
* [Function] myFunction1.[Function] myFunction2
* [Class] myClass1.[Method] myMethod1
* [Class] myClass1.[Class] myClass2.[Method] myMethod2

設定

lowpolysnow.outlineToText.targetSymbols : 「メソッド一覧」取得のコマンドで、対象にするシンボルの種類を指定できます。詳細は、設定画面の説明を参照してください。
lowpolysnow.outlineToText.withLineNumber : 「メソッド一覧」取得のコマンドで、先頭に行番号を付与します。

要件

この拡張機能は、VSCode がシンボル抽出をサポートしているすべての言語で動作します。

リリースノート

0.0.1

初期リリース

開発用ビルド方法

npm i npx vsce package

開発用インストール方法

code --install-extension outline-to-text-0.0.1.vsix

開発用アンインストール方法

code --uninstall-extension outline-to-text-0.0.1.vsix 上記はvsixファイルのある場所で実行しないとエラーになるので、その場合は下記で拡張機能の識別子を指定して削除してください。 code --uninstall-extension lowpolysnow.outline-to-text

Outline to text

lowpolysnow