cmake tidy

cmake-tidy

目次

• 1。はじめに
• 2。アプリケーションの使用
  • 2.1。 formatサブコマンド
  • 2.2。サブコマンドanalyze
• 3。既知の制限/バグ
• 4。その他の情報
  • 4.1。インストール
  • 4.2。 CIステータス

1。はじめに

プロジェクトの目標は、 CMakeで記述されたビルドシステムコードの開発プロセスを容易にする一連のツールを提供することです。ツールの主なアイデアは次のとおりです。

• CMakeコードのフォーマット - 言語構文分析に基づいています

• 最新のCMake静的分析 - 自動固定の可能性を備えた基本的なコード分析。

• 構成の柔軟性が大きくなります - コーディングスタイルが大きく異なります。

• 使いやすい - ユーザーの学習曲線を削減するための他の最先端のツールとの使用とパラメーターを模倣します。

2。アプリケーションの使用

cmake-tidyは、 python3で記述されたコマンドラインアプリケーションです。

利用可能なサブコマンド：

 usage: cmake-tidy [-h] {format} ...

optional arguments:
  -h, --help  show this help message and exit

sub-commands:
  {format}    see "cmake-tidy <command> --help" to read more about a specific
              sub-command.
    format    format file to align it to standard

2.1。 formatサブコマンド

2.1.1。使用法

 usage: cmake-tidy format [-h] [--dump-config] [-i] [--diff] [--verbose]
                         [input [input ...]]

positional arguments:
  input          CMake file to be formatted

optional arguments:
  -h, --help     show this help message and exit
  --dump-config  Dump to stdout current settings. Script tries to read
                 settings from `.cmake-tidy.json` or provides default
                 settings. Precedence of searching `.cmake-tidy.json` is
                 described on github
  -i, --inplace  Inplace edit specified <input_data> file
  --diff         Print to stdout unified diff between original file and
                 formatted version.
  --verbose      Print to stdout information about formatted file 

2.1.2。構成

ユーザーは、カスタム.cmake-tidy.jsonファイルを提供することにより、アプリケーションに代替設定を提供できます。利用可能なパラメーターと値の詳細については、こちらをご覧ください。

2.2。サブコマンドanalyze

はじめに進行中です。

3。既知の制限/バグ

• アプリケーションは、有効なcmakeファイルのみをフォーマットできます（構文エラーにより、フォーマットされたファイルのコンテンツを変更せずにアプリケーションが終了します）。

• --versionコマンドで指定されているよりも、cmakeの古いバージョンのdeprecatedキーワード/プロパティのサポートが制限される場合があります。それらをサポートする必要がある場合は、 .cmake-tidy.json構成ファイルのカスタムキーワードとしてプルリクエストを提供するか、それらを指定してください。

• ラインの継続ハンドリングは実装されていません。

4。その他の情報

4.1。インストール

このツールは、コマンドを使用してPythonパッケージインデックスを介して利用できます。

python3 -m pip install cmake-tidy

インストールが成功したことを確認するには、実行できます。

cmake-tidy -v

4.2。 CIステータス

自動テストは、ワークフローで行われます。

• ubuntu-lastest, python-3.8

• windows-lastest, python-3.8