先日、日本語から、英語の関数名や変数名に変換してくれるサービスのcodicを紹介しました。
そのcodicを久しぶりに利用してみたら、プラグインに以前は、「Coming soon」となっていたSublime Text 3用のパッケージが追加されていました。
そのパッケージのうちの一つがSublimeCodicです。
しばらく利用してみたところ、Sublime Text上の日本語を、英語関数名などに手軽にできる、かなり便利なツールだったので紹介です。
以下では、SublimeCodicの導入方法から、使い方、設定方法などについて詳しく説明したいと思います。
目次
SublimeCodicとは
SublimeCodicは、手軽にcodicの「日本語→英語関数名」機能を利用できるSublime Text 3用のパッケージです。
codicを利用するためのSublime Text 3パッケージは、SublimeCodicの他にも、いくつかあるのですが、その中で最も高機能なパッケージとなっています。（※この記事を書いている時点）
現時点で、Sublime TextのPackage Controlに対応していないので、最初の設定に数手間余計にかかりますが、最初に設定さえしてしまえば、関数名や変数名のネーミングなどで、かなり助けとなるパッケージになっていると思います。
SublimeCodicのインストール
まずはSublime Textに、パッケージをインストールします。
Package Controlの直接インストールには対応していないので、リポジトリの追加から行う必要がありますが、大して難しくはないと思います。
リポジトリの追加
まずは、Sublime Textにリポジトリを追加します。
追加するには、「Preferences → Package Control」を選択します。
リストが表示されたら「Package Control: Add Repository」を選択してください。
すると、以下のようにエディター下部に入力ボックスが表示されるので、以下のURLを入力してエンターキーを押してください。
https://bitbucket.org/dat/sublimecodic
これで、リポジトリにSublimeCodicが登録されました。
SublimeCodicのインストール
次に、パッケージのインストールを行います。
インストールも「Preferences → Package Control」を選択します。
すると、以下のようなリストが表示されるので「Package Control: Install Package」を選択します。
すると以下のようなSublime Textのパッケージリストが表示されるので、
入力欄に「SublimeCodic」と入力して、表示されたSublimeCodicパッケージを選択してください。
これで、SublimeCodicパッケージがインストールされます。
SublimeCodicパッケージの設定
Sublime Textで、SublimeCodicパッケージを利用するには、codicからAPIへのアクセストークンの設定をする必要があります。
codicのAPIを利用するには、codicに無料登録する必要があります。
以下では、codicに無料登録済みということで説明を行います。
codicからアクセストークンの取得
まずはcodicにログインした後、APIステータスページを開きます。
すると、以下のような画面が表示されるので、アクセストークンをコピーなどして、どこかに控えておいてください。
SublimeCodicの設定
次に、SublimeCodicの設定でアクセストークンを設定したり、変換方式を設定したりします。
まずは、「Preferences → Package Settings → codic → Settings – User」を選択します。
すると、設定用のファイルが表示されるので、以下のように入力して保存します。
{
"access_token": "codicサイトから取得したアクセストークン",
"casing": "camel",
"acronym_style": "camel strict"
}
access_token
access_tokenには、先程控えておいたアクセストークンを入力します。
casing
casingには、以下のようなケース変換方式を設定します。
- 何も入力しない：ケース変換を行わない
- camel：キャメルケース（JavaScript、jQueryなど）
- pascal：パスカルケース（Delphiなど）
- lower underscore：スネークケース小文字（PHPなど）
- upper underscore：スネークケース大文字（定数など）
- hyphen：ハイフネーション（ハイホンで繋ぐ）
詳細はAPIを参照。
acronym_style
acronym_styleには、パラメータcasingに、camel, pascalのいずれかを指定した場合の頭字語（例: SOA）の処理方法を指定します。
以下のいずれかを設定します。
- MS naming guidelines
- camel strict
- literal
詳細はAPIを参照。
SublimeCodicキーバインドの設定
上記までの設定で、SublimeCodicの機能を利用することができるようになります。
ただ、このままだと利用するには、コマンドパレットからコマンドを打つ必要があるので、ショートカット一発で機能が利用できるように、キーバインドの設定を行っておきます。
キーバインドの設定を行うには、「Preferences → Key Bindings – User」を選択します。
ユーザー用のキーバインドファイルが表示されるので、以下のように設定します。
[
{
"keys": ["alt+t"], "command": "codic_translate_string"
},
{
"keys": ["alt+i"], "command": "codic_input_string"
},
]ショートカットキーは、使いやすいものを設定してください。既に他のキーバインド設定が行われている場合は、[]内に書式が崩れないように入力してください。
これで、ショートカットキーなどから関数名変換などを一発でできるようになります。
SublimeCodicの使い方
これで、設定は完了したので、以下で使い方を紹介します。
日本語を英語名に変換（translateコマンド）
まずは、エディター上の日本語を英語名に変換する方法です。
以下のように、日本語部分を選択します。
そして、メニューから「Tools → Command Palette」を選択します。（ショートカットの Ctrl + Shift + P でもOK）
すると、コマンドパレットが表示されるので入力欄に「codic」とでも入力して、「codic: translate」を選択すると「ノードを取得する」という日本語でつけた関数名が「getNode」に変換されます。
コマンドパレットの「codic: translate」コマンドには、先程キーバインド設定でショートカットキーを割り当てたので、Alt + T でも手軽に変換することができます。
日本語をインプットして英語名に変換（inputコマンド）
エディターに日本語が書かれてなくても、手軽にインプットボックス呼び出して英語名を取得することもできます。
まずは、英語名（関数名など）を取得したい箇所に入力カーソルを置きます。
そして、メニューから「Tools → Command Palette」を選択します。（ショートカットの Ctrl + Shift + P でもOK）
すると、コマンドパレットが表示されるので入力欄に「codic」とでも入力して、「codic: input」を選択します。
すると、エディター下部にインプットボックスが表示されるので、英語名に変換したい日本語を入力してエンターキーを押します。
例えば「ノードは空か」という日本語を入力すると、「isNodeEmpty」と英語の関数名に変換されて挿入されます。
いちいちコマンドパレットから「codic: input」コマンドを選択するのが面倒くさい場合は、先程キーバインドで設定した Alt + I ショートカットで一発で入力ボックスを呼び出すことができます。
まとめ
このように、Sublime TextのSublimeCodicパッケージを利用すると、日本語から英語関数名（変数名）などの変換をショートカットキー一発で行うことができるようになります。
何も考えないで、適当に関数名を作るよりは、codicのようなサービスを用いて、機械的にネーミングをした方が、適当な名前よりは良いのではないかと思います。
あと、codicと言えば、辞書を用いてより良い英単語を単語リストから選択するなんてこともできますが、今回のパッケージでは単語変換を行うことはできません。
そういったことをする場合は、以下の方法などと組み合わせて利用するのがお勧めです。
