概要

ファイルのプログラムをチェックする npmのCLIツール。（CIサイト用）

使い方

このリポジトリをクローンします。

$ npm run build と $ npm link を実行し、npmのCLIツールとしてローカルに登録します。その後は下記コマンドで実行できるようになります。

$ ci-review all // 実行したディレクトリの中にある、すべてのファイルを調べます。

$ ci-review select [ファイルパス] [ファイルパス] [ファイルパス] ...  // 記述されたファイルパスのみ調べます。

$ ci-review select_filter [ファイルパス] [ファイルパス] [ファイルパス] ...  // レベル高,中のみの結果を返します。

実行すると、review.csvが生成されます。（実行のたびに review.csvに追記します。）

例1）githubから、コミットの差分ファイルだけをチェックする場合は、そのブランチにチェックアウトし、下記を実行。

# （HEADの後には、コミット数分 ^ を付ける）
$ ci-review `git diff --diff-filter=d --name-only HEAD^^^ HEAD`

git diff が差分ファイルパスだけを出力してくれるので、それを ci-review に渡すだけです。

例2）git ls-files で git上の全てのファイルをチェックします。

ファイルが多すぎるときは、パイプ と xargs で区切って渡します。

基本こんな感じでやっておけばOK

'-z' と '-0' でスペースの入ったファイルを処理できます。

$ git ls-files --full-name -z | xargs -0 ci-review

チェック項目

• PHP
  • 使用不可・非推奨関数の記述を調べる
• JavaScript
  • 使用不可関数 eval の記述を調べる
• HTML
  • htmlのリントが正しいか調べる。
  • jqueryの読み込み先が /assets_common/js/jquery.js か調べる。

開発環境

• node v14.19.1
• npm 6.14.16

開発時インストール

$ npm i

./srcのtsファイルを監視して、./distにbuildします。

$ npm run watch