Skip to content

tritask/tritask-vscode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tritask-vscode

VSCode 版 Tritask です。

190818_tritask-vscode-demo

システム要件

  • Visual Studio Code
  • Windows 7+ あるいは MacOS 10.14(Mojave)+
  • Python 3.6+
    • 内蔵コマンド(helper.py)が Python 製なので Python も必要です
    • ⚠️ python3 コマンドで Python 3.x を呼び出せる必要があります

インストール

tritask-vscode は以下から構成されます。

  • シンタックスハイライトをつかさどる tritask-basics
  • 各種操作をつかさどる tritask-language-features

tritask-vscode のインストールには上記二点のインストールが必要です。

手順:

  • 1: tritask-basics の vsix ファイルを VSCode にインストールする
  • 2: tritask-basics の settings.json を、あなたの settings.json に追記する
    • これをしないと .trita ファイルの中身がハイライトされません
  • 3: tritask-language-features の vsix ファイルを VSCode にインストールする

なお、vsix ファイルのインストールは Command Palette > Install from VSIX あるいは code --install-extension xxxxx.vsix にて行なえます。

インストールが完了すると、以下のように Tritask syntax と Tritask command の二つが enabled になります。

190818_tritask_extension_found

使い方

.trita ファイルを開くと、シンタックスハイライトが効いているはずです。また .trita ファイル内に限り、各操作が有効になっています。以下方法より呼び出せます。

  • editor/context(エディタ上での右クリックメニュー)
  • Command palette(Ctrl + Shift + P) > tritask で検索
  • Key bindings(キーボードショートカット)

以下は editor/context のスクショです。

190818_tritask_extension_editorcontext

License

MIT license

Author

stakiran




開発者向け情報

VSCode による拡張機能開発については公式サイト、あるいは本ツール開発時に書いた以下記事を参照ください。

必要な環境

  • Node.js
  • npm
    • npm install -g yo
    • npm install -g generator-code
    • (パッケージングがしたいなら) npm install -g vsce

ディレクトリ構成について

  • 以下から成ります
    • シンタックスハイライトをつかさどる tritask-basics
    • メニュー表示やタスク操作など各種操作をつかさどる tritask-language-features
  • 各々が VSCode 拡張機能開発用のプロジェクト(yo code で生成したもの)になっています。

⚠️ 開発時は 各々のディレクトリをカレントディレクトリにしてから VSCode を開いてください。

以下は ⭕ 正しいケース

$ cd
D:\work\github\stakiran\tritask-vscode

$ cd tritask-language-features

$ code .

以下は ❌ 正しくないケース(tritask-language-features をカレントディレクトリにしていない)。これをすると import パスなどが正しく解決されず VSCode がエラーを吐きます。

$ cd
D:\work\github\stakiran\tritask-vscode

$ code .

バージョン管理について

  • ⚠️ master ブランチが安定しているとは限りません
  • 区切りの良いバージョンはタグを切ってリリースしています

ビルド(パッケージング)する

tritask-language-features のビルドを行う例です。

ビルドといっても vsce を用いてパッケージングを行うだけです。

$ cd tritask-language-features
$ vsce package
$ ls *.vsix
tritask-language-features-0.0.1.vsix

既にビルドスクリプトがあります。

👉 build.batbuild.sh

おわりに

その他詳しい情報は、各々の README を見てください。