illuaminate

イルアミネート

LUAのソースコード分析

Illuaminateは、LUAソースコードを操作するための一連のツールであり、コードベースをより明確かつ理解しやすくする方法を提供します。現在、それはかなり裸の骨であり、まだPOC段階にありますが、うまくいけば拡大し、それが発展し続けるにつれてより有用になるでしょう。

特徴

• 多くの基本的な静的分析機能（死んだコード検出、未使用変数など）といくつかのフォーマットリン（空白、冗長な括弧など）。
• 多くの検出された問題の自動コードフィクサー。
• LDOC構文を使用したドキュメント生成。

建物

注： upx実行可能ファイルを使用して、コンパイルされたファイルを妥当なサイズにします（4x削減します）。ほとんどのパッケージマネージャーに含める必要があります。

オパムを使用します

• OPAMをインストールし、OCAML> = 4.08.1スイッチをセットアップします（例： opam switch create 4.11.1 ）。
• 他のすべての依存関係をインストールします： opam install --deps-only --with-test .
• duneを使用してビルド： dune build @install @runtest
• dune installを使用してIlluaminateをOpamにインストールするか、 _build/install/default/binディレクトリのファイルを使用することができます。

ESYを使用します

• ESYをインストールします
• リポジトリのルートでesyを実行します。
• イルアミネートはesy x illuaminateを使用して実行できるようになりました

使用法

• 上記のようにイルアミネートを構築するか、事前に構築されたバージョンをダウンロードしてください。

   > wget https://squiddev.cc/illuaminate/bin/latest/illuaminate-linux-x86_64 # A x86-64 Linux static binary
  > wget https://squiddev.cc/illuaminate/bin/latest/illuaminate-windows-x86_64.exe # A x86-64 Windows binary
  

  ダウンロードしたファイルをchmod +xする必要がある場合があります。

• illuaminate lintして現在のディレクトリを糸くし、またはilluaminate lint my/sub/directory特定のファイルまたはフォルダーを並べます。検出されたすべての問題のレポートを受け取る必要があります。

• illuaminate fix （またはilluaminate fix my/sub/directory ）を使用して、検出された問題を修正しようとします。このコマンドはファイルを設置されているため、ファイルを修正する前にファイルをバージョンコントロールに確認し、変更された変更に満足していることを確認することをお勧めします。

• 構成ファイルを使用して、イルアミネートをより細粒化する制御を取得できます。 illuamiante init-config illuaminate.sexpニーズに合わせて調整できるテンプレート構成ファイルを生成します。