自動整形機能をカスタマイズする

自動整形機能の設定方法を学びます。

AUTHOR: Benjamin Dannegård, Per Tillisch、LAST REVISION: 2022/12/15 18:35

Arduino IDE 2.0でスケッチを書くときに、編集 > 自動整形を選ぶか、ウインドウズ/LinuxでCtrl+TもしくはMacOSでCMD+Tを選べば、スケッチを自動整形します。このコマンドの振る舞いを変更することができます。このチュートリアルでは、このコマンドの振る舞いをどのようにすれば変更できるのかを示します。

エディタは、Arduinoソフトウェアのページから簡単にダウンロードすることができます。

エディタのインストールの詳細は、Arduino IDE 2.0のダウンロードとインストールのチュートリアルに従ってください。

必要なもの

Arduino IDE 2.0がインストールされていること

設定方法

自動整形機能の設定は、2つの方法で定義することができます。自動整形機能の設定は、エディタで開くスケッチ全てをカバーする全体設定と、特定のスケッチだけの個別設定に分けられます。

Aduino IDE 2.0で使われている自動整形ツールはClangFormatです。設定オプションのドキュメントはここにあります。

全体設定

以下のどこかの場所に、.clang-format設定ファイルを配置すれば、Arduino IDE 2.0はArduinoのデフォルト設定ではなく、このファイルを常に使います。

Windowsを使っていれば、ファイルを以下に配置してください。

`1`	`C:\Users\<username>\.arduinoIDE\`

もしくは、

`1`	`C:\Users\<username>\AppData\Local\Arduino15\`

Linuxを使っていれば、ファイルを以下に配置してください。

`1`	`~/.arduinoIDE/`

もしくは、

`1`	`~/.arduino15/`

macOSを使っていれば、ファイルを以下に配置してください。

`1`	`~/.arduinoIDE`

もしくは、

`1`	`~/Library/Arduino15/`

スケッチ毎の設定

スケッチのルートに、.clang-format設定ファイルを配置すれば、Arduinoはこのファイルを使います。このファイルは、全体設定ファイルよりも優先されます。

デフォルトの整形ファイル

Arduino IDE 2.0で使われるデフォルトの整形ファイルは以下にあります。IDEでの自動整形の振る舞いをカスタマイズしたければ、このファイルから始めることをおすすめします。

https://raw.githubusercontent.com/arduino/tooling-project-assets/main/other/clang-format-configuration/.clang-format

カスタム設定はマージされるのではなく、Arduinoのデフォルト設定を完全に上書きします。設定ファイルで設定しなかった全てのオプション設定は、ClangFormatのデフォルト値になります。

おわりに

このチュートリアルでは、Arduino IDE 2.0でのCTRL+T/CMD+Tによる自動整形の振る舞いのカスタマイズ方法を紹介しました。このチュートリアルでは、自動整形の設定で利用できる異なる設定スコープも紹介しました。

他のチュートリアル

Arduino IDE 2のドキュメントページに多くのチュートリアルがあります。

オリジナルのページ

https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-customize-auto-formatter

最終更新日

January 7, 2023