atom-beautifyにuncrustifyを導入する手順を紹介【Java,C言語向け】

 

Atomでコードフォーマットを入れるときに、使うパッケージはatom-beautifyです。

このときJavaやC言語で開発したい人はuncrustifyというコード自動整形ソフトをダウンロードして設定する必要があります。

僕自身、AtomでJavaの開発環境を整える際に利用したんですが、少しはまってしまったのでここに落としておきます。

 

前提

 

この記事では、以下の項目を前提としています。

  • JDKおよびAtomのインストールを終えている
  • AtomでのJavaのコンパイルが実行できる
  • Atomでの文字化け対策などを終えている

 

まだ、それに至らない方は、こちらから環境設定をしてみてください。

Javaの開発環境をAtomでつくる方法【初心者おすすめ】

 

また、同内容の外部記事のリンクも張っておきます

AtomでJavaの開発環境を整える(外部リンク)

※ただしこの記事でのuncrustifyの説明は不十分なことが多いです。

前提までの設定を終えたらこのページに戻ることを推奨します。

 

uncrustifyのダウンロード

 

まずはuncrustifyをダウンロードしましょう。

こちらからダウンロードを進めてください

uncrustifyのダウンロード

 

自身にあったバージョンをダウンロードして解凍。

任意のフォルダに保存します。

 

uncrustifyのPathを通す

 

次にuncrustifyのpathを通しましょう。

おそらくJDKのインストールの際に一度実行したことがあると思いますがユーザー環境変数(もしくはシステム環境変数)の設定から、Pathを選択します。

そして、先ほどuncrustifyを保存した場所を追加しましょう。

※僕の場合は”C:\dev\uncrustify”です。

 

これで一旦、uncrustify側の設定は完了です。

 

atom-beautifyのインストール

 

では次に、Atomを起動してatom-beautifyをインストールします。

インストールが完了したらメニューからFile >Settingsを選択。

packageからatom-beautifyのsettingに移動します。

 

設定画面を下に移動すると、各言語の設定画面が現れると思うので、Javaを選択してください。(C言語の環境を整えたい方はC言語を選択してください)

「Java」の項目が見つかったら、まず、「Beautify On Save 」をONにしてください。

 

そして、ConfigPathで”uncrustify.cfg”ファイルを指定してします。

※僕の場合は”C:\dev\uncrustify\uncrustify.cfg”です。

 

uncrustify.cfgを用意する

 

ConfigPathで”uncrustify.cfg”ファイルを指定。

実はここが少しハマるポイントだったのです。

 

もともとのuncrustifyのダウンロードファイルには”uncrustify.cfg”が含まれていません。

つまり自前で用意せざるを得ないということになります。

では、Atomで”uncrustify.cfg”を準備していきます。

 

先ほど指定した場所にuncrustify.cfgを作成していきます。

(拡張子を間違えないようにしてください)

Atomで編集していきましょう。

 

準備するといっても簡単です。

新規で作成している”uncrustify.cfg”ファイルに下のコードをそのまま張り付けるだけです。

 

 

一度、これを保存しましょう。

そして任意のjavaファイルを起動し追加保存してみましょう。

(HelloWorldなどテスト用のコードを使ってみるのがおススメです)

おそらくこのままだとエラーメッセージが表示されると思います。

コード整形がうまくいっていないようですね。

このcfgファイルに少しばかり手を加えていきます。

 

uncrustify.cfgを編集する

 

エラーメッセージを読めばわかると思いますが、問題点を整理していきます。

  • 315行目 コメントを2行にする
  • 339行目 コメントを2行にする
  • 485行目 D言語をignoreにする
  • 597行目 コメントを2行にする

 

以上の項目を編集して保存。

再度テストコードを動かしてみましょう。

しっかりと保存されれば成功です。

 

参考サイト

 

▽AtomでJavaの開発環境を整える

https://qiita.com/stupid_student2/items/3e8ffeb33a73ef065a40

 

▽atomにatom-beautifyを入れたときにハマったこと

https://koejima.com/archives/748/

 

▽意識の高さからかコードフォーマッター設定を公開

https://qiita.com/ayakix/items/3f05da9541b8e130e39f

← 過去の投稿へ

次の投稿へ →

2 Comments

  1. java 初心者

    参考になります。

    “uncrustify.cfgを編集する”
    で何行目を修正するというのは理解できましたが
    具体的な方法を画像等で示すことは可能でしょうか。

    • bluesky_works

      返信遅れましたこと申し訳ありません。
      そのときにピクチャを残さなかったため画像で示すことはできません。

      ですが、編集内容は簡単です。
      uncrustify.cfgファイルを新規で作成して、前項のコードをそのまま貼り付け対応している行の部分を直すだけです。
      例えば、315行目でエラーが出ている原因は、「横に長すぎること」であるので
      コメントを区切りの良いところ(どこでもよい)で2行にしてしまえばエラーは解消されます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA