【Windows】 Atom に atom-beautify をインストールしてソースコードの崩れたインデントを一括整形する方法

スポンサーリンク

 

テキストエディタ「Atom」を使い始めて、1つ困ったことがありました。

それは、「崩れたインデントを一括で整形する方法」が見当たらないことです。

 

これまで使っていた某統合開発環境では【Ctrl】+【K】+【F】で選択範囲を一括で整形することができたのですが、

「Atom」は割り当てられたショートカットキーが多すぎて、正直探すのが面倒でした。

Atomで遊んでみて気が付きましたが【Edit】>【Lines】>【Auto Indent】のGUI操作で整形する以外に、

そもそも1発で全範囲のインデントを整形するショートカットキーは存在しないようでした。

 

なら「 “Auto Indent” を自分でショートカットに割り当てればよいのでは?」と思う方もいらっしゃると思いますが、

その場合もまず【Ctrl】+【A】で全範囲を選択してから実行しなければなりません。

僕はあくまでも「1発」にこだわりたかったので。

 

そんなとき、友人に教えてもらったパッケージが「atom-beautify」でした。

どうやらこのパッケージを導入すると

 

【Ctrl】+【Alt】+【B】

このショートカットだけで全てのインデントを整形することができるようです。

そこで今回は atom-beautify をインストール & 環境設定を整えつつその忘備録を書いていこうと思います。

 

atom-beautify のインストール

 

インストールは簡単です。

Atomを起動させ【Settings】>【Install】から【Install Packages】のフォームに「atom-beautify」を入力します。

恐らく先頭に検索結果が出てきますので、【Install】をクリックしてください。

「 Settings 」で何かを調整するようでしたが、「きっとカスタマイズ云々だろう」と思い後回しにして早速試してみることにしました。

適当なプログラムを持ってきて意図的にインデントを崩し、【Ctrl】+【Alt】+【B】を打鍵しました。

 

はい。エラーが出ました。「WTF !?!?!?!?!?!?!?!?!?!?!?!?」

 

仕方がないのでエラーの原因を突き止めましょう。

ふむふむ。

どうやら他にも “uncrustify”というインストールすべきプログラムがあってその実行ファイルまでのパスを「atom-beautify」に設定する必要があるそうです。

とりあえず詳しい設定手順などが説明されているらしい指定されたページにアクセスします。

https://github.com/Glavin001/atom-beautify#beautifiers

このページには

  •  「atom-beautify」にどの Beautifier が既にインストールされているか
  •  プログラミング言語毎にどの Beautifier が対応しているか
  •  Beautifier をどうやってインストールするのか
  •  「atom-beautify」をどうやって使うのか

などなど役立つ情報がたくさん書かれています。

me

あ。Beautifier は「atom-beautify」の核で実際に動作するソースコードの整形ツールのことです。

 

色々と書いてありますが、やるべきことを簡単にまとめました。

  1.  「uncrustify」をインストールする
  2.  「atom-beautify」の【 Settings 】> 【Exectables】>【Uncrustify】に実行ファイル「uncrustify.exe」までのパスを設定する
  3.  「atom-beautify」の【Settings 】> 【C++】>【Config Path】 に設定ファイル「uncrustify.cfg」までのパスを設定する

今回はC++言語で書かれたソースコードの場合を例に説明しますが、他の言語の場合も手順自体は同じです。

C++言語に対応する Beautifier の「uncrustify」 を対象にしていますが、

  •  Beautifier のインストール方法
  •  特定のプログラミング言語にどの Beautifier が対応しているか

 

などは このページの「Language Support」と「Beautifiers」を参考にしてください。

 

[1]  uncrustifyのインストール

正式名称「Uncrustify Code Beautifier」はここからダウンロードして【保存】します。

保存した zipファイルを展開し、展開したフォルダを以下のディレクトリに移動させます。

C:\Users\ユーザー名\.atom\packages\atom-beautify

 

GUI操作でもCUI操作でも構いませんので移動させておくと管理が楽です。

 

以上で必要な Beautifier のインストールは完了です。

[2]  実行ファイルまでのパスを設定する

Atomを起動したら【Settings】>【Packages】から「atom-beautify」の【Settings】を選択します。

次に【Exectables】>【Uncrustify】から「Binary/Script Path」に以下を設定します。

C:\Users\ユーザー名\.atom\packages\atom-beautify\[1]でダウンロードしたフォルダ名\uncrustify.exe

 

 

[3]  設定ファイルまでのパスを設定する

[2] の設定ページの下に【C++】があると思いますのでクリックします。

【Default Beautifier】が「Uncrustify」であることを確認して、

「Config Path」に拡張子が .cfg の設定ファイルである uncrustify.cfgまでのパスを設定します。

 C:\Users\ユーザー名\.atom\packages\atom-beautify\examples\nested-jsbeautifyrc\uncrustify.cfg

 

以上で「atom-beautify」を利用するための環境設定が終わりました。

 

動作確認

 

先ほどの試行では警告文が出て、崩れたインデントを整えてくれませんでしたが次はどうでしょうか?

 Before

 

 After 【Ctrl】+【Alt】+【B】

綺麗にインデントが整えられました。

これからは楽に1発で整形できるようになりました。

 

以上「atom-beautify」の導入法でした。

ではまた!

スポンサーリンク


ABOUT ME

yuk!

国立大学情報学科に通う大学生です。天然パーマと戦いながらすーぱーエンジニアを目指し技術とセンスを磨いています。 室内に引きこもりがちでヘビメタと猫と甘いものが救いのキーボードカチャカチャ生活ですが、最近はブログで文章を書くことが楽しいです。モットーは「 Who dares wins. = 人生是一箇,活殺全在我。」好きな言葉は「マジ卍」。