r271-635

コマンドラインでの使い方

チェックレベルは5段階あり、1が最も厳しいチェックが入り、5は最低限のチェックしか行われない。

チェックレベル（公式Webページからの転載）

    SEVERITY NAME   ...is equivalent to...   SEVERITY NUMBER
    --------------------------------------------------------
    --severity gentle                           --severity 5
    --severity stern                            --severity 4
    --severity harsh                            --severity 3
    --severity cruel                            --severity 2
    --severity brutal                           --severity 1

実際に、チェックを行った場合の表示例

$ perlcritic --severity 1 test.pl
エラー: No word lists can be found for the language "ja_JP".
Code is not tidy at line 1, column 1.  See page 33 of PBP.  (Severity: 1)
No package-scoped "$VERSION" variable found at line 1, column 1.  See page 404 of PBP.  (Severity: 2)
Useless interpolation of literal string at line 10, column 11.  See page 51 of PBP.  (Severity: 1)
Useless interpolation of literal string at line 14, column 7.  See page 51 of PBP.  (Severity: 1)
Return value of flagged function ignored - print at line 16, column 1.  See pages 208,278 of PBP.  (Severity: 1)
Builtin function called with parentheses at line 21, column 5.  See page 13 of PBP.  (Severity: 1)
Return value of flagged function ignored - print at line 21, column 5.  See pages 208,278 of PBP.  (Severity: 1)
Useless interpolation of literal string at line 21, column 12.  See page 51 of PBP.  (Severity: 1)
Builtin function called with parentheses at line 22, column 5.  See page 13 of PBP.  (Severity: 1)
Return value of flagged function ignored - print at line 34, column 1.  See pages 208,278 of PBP.  (Severity: 1)
Useless interpolation of literal string at line 34, column 7.  See page 51 of PBP.  (Severity: 1)

$ perlcritic --severity 2 test.pl
No package-scoped "$VERSION" variable found at line 1, column 1.  See page 404 of PBP.  (Severity: 2)

$ perlcritic --severity 3 test.pl
test.pl source OK

Visual Studio Codeで利用する場合

Perl Toolbox拡張機能を導入するとperlcriticが使えるようになる

設定画面では...

実行ファイル設定（Lint:Exec perlcritic library）に、perlcritic コマンドがデフォルトで設定されている

また、チェックレベル設定（Lint:Severity）はデフォルトでは brutal（レベル 1） となっているが、警告が出すぎるので、cruel（レベル 2）あたりが妥当なレベル。なお、このチェックレベル設定は、~/.perlcriticrc 内の設定より優先される

無効化したい警告は、~/.perlcriticrc に書くのではなく、VS Codeのsettings.jsonに書く （~/.perlcriticrc を読み込んでくれないのは、バグなのか、そういう仕様なのか、私が設定箇所を間違っているのか...）

ソースコード

{
    "workbench.colorTheme": "Visual Studio Dark",
    "[perl]": {
        "editor.defaultFormatter": "Kaktus.perltidy-more"
    },
    "editor.formatOnType": true,
    "editor.fontSize": 15,
    "editor.renderWhitespace": "boundary",
    "editor.renderLineHighlight": "all",
    "files.eol": "\n",
    "workbench.editorAssociations": {
        "*.ipynb": "jupyter.notebook.ipynb"
    },
    "perl-toolbox.lint.severity": "cruel",
    "perl-toolbox.lint.excludedPolicies": [
        "ControlStructures::ProhibitCStyleForLoops",
        "Modules::RequireVersionVar",
    ]
}

（Pythonコード整形）autopep8

公式Webページとドキュメントはこちら（https://github.com/hhatto/autopep8）。

インストールはlinuxのパッケージマネージャで行う

$ sudo apt-get install python3-autopep8

コマンドラインでの使い方

$ autopep8 --in-place --aggressive --aggressive test.py

--in-place スイッチは、整形結果を上書き保存する。--aggressive スイッチは複数つけることができ、つけるほどに最適化レベルが上がる。

Visual Studio Codeで利用する場合

MicrosoftのPython拡張機能を導入すれば、autopep8の機能が使えるようになる。※2022年4月追記 : autopep8機能はMicrosaoft Python拡張機能から独立した単体の拡張機能となったため、autopep8拡張機能を導入すること。

コード整形が必要になれば、エディタ画面で F1 キーを押し、検索ボックスに Format と入力すれば、整形ツール（Formatter）メニューが表示される。

autopep8 実施時のオプション（プログラム起動時の引数）は、 settings.json に書き込んでおけばよい

ソースコード

{
    "workbench.colorTheme": "Visual Studio Dark",
    "[perl]": {
        "editor.defaultFormatter": "Kaktus.perltidy-more"
    },
    "editor.formatOnType": true,
    "editor.fontSize": 15,
    "editor.renderWhitespace": "boundary",
    "editor.renderLineHighlight": "all",
    "files.eol": "\n",
    "workbench.editorAssociations": {
        "*.ipynb": "jupyter.notebook.ipynb"
    },
    "perl-toolbox.lint.severity": "cruel",
    "perl-toolbox.lint.excludedPolicies": [
        "ControlStructures::ProhibitCStyleForLoops",
        "Modules::RequireVersionVar",
    ],
    "python.formatting.autopep8Args": [
        "--aggressive",
        "--aggressive",
        "--max-line-length", "80",
    ],
}

※autopep8拡張機能の設定例は次の通り

    "autopep8.args": [
        "--aggressive",
        "--aggressive",
        "--max-line-length",
        "100"
    ],

（Python 文法チェック）flake8

公式Webページとドキュメントはこちら（https://pypi.org/project/flake8/）

インストールはpipで行うことも出来るし、

$ sudo apt-get install python-flake8
$ sudo apt-get install python3-flake8

あるいはpipコマンドで行える

$ pip install flake8
$ python3 -m pip install flake8

上で上げたインストールコマンドは、それぞれ上段はPython2、下段はPython3用で、両方がインストールされているシステムでは必要な方（あるいは両方）をインストールする

コマンドラインでの使い方

$ flake8 --statistics --show-source test.py

Visual Studio Codeで利用する場合

設定の Linting: Flake8 Enabled にチェックを入れて有効化する （私の環境では、デフォルトで無効となっていた）。

また、flake8の設定項目の少し上に Linting: Enabled というチェック項目もあるため、こちらも有効となっているか念のため確認

文法チェックが必要になれば、エディタ画面で F1 キーを押し、検索ボックスに Lint と入力すれば、文法チェック（Run Lint）メニューが表示される。

（PHPコード整形）phpcbf

phpcbf（コード整形） と phpcs（文法チェック）は、GitHubのリポジトリPHP_CodeSnifferで配布されている。

PHPのライブラリ管理ツールComposerや、一昔前のライブラリ管理ツールPEARでもセットアップできるようだが、自分の目で見てセットアップするには、GitHubから直接ダウンロードして展開するのがいちばんかんたん。

GitHubからダウンロードしたパッケージのディレクトリを、まるごと/opt 以下にコピーする。そして、PATHの通っているディレクトリ（/usr/local/bin/）に、phpcbfとphpcsコマンドのシンボリックリンクを作る。

$ git clone https://github.com/squizlabs/PHP_CodeSniffer.git
$ sudo cp -r ./PHP_CodeSniffer /opt
$ sudo ln -s /opt/PHP_CodeSniffer/bin/phpcbf /usr/local/bin/
$ sudo ln -s /opt/PHP_CodeSniffer/bin/phpcs /usr/local/bin/

コマンドラインでの使い方

$ phpcbf --standard=PSR12 test.php

対象ファイルはバックアップ無しで上書きされる。

上の例では PSR-12コーディング規約に準拠するコード整形を行っているが、サポートする規格一覧は次のコマンドで出力できる。引数 --standard でコーディング規約を指定しなければ、PEARコーディング規約が用いられる（phpcbf -v で利用されるコーディング規約を表示できる）

$ phpcbf -i
The installed coding standards are PSR2, Zend, PEAR, PSR1, PSR12, MySource and Squiz

（PHP文法チェック）phpcs

phpcbf と同時にインストールされるので、インストール方法は cppcbf の項目を参照

コマンドラインでの使い方

$ phpcs --standard=PSR12 test.php
FILE: /home/user/test/test.php
---------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------
  5 | ERROR   | [x] Whitespace found at end of line
  6 | ERROR   | [x] Whitespace found at end of line
 13 | ERROR   | [x] Expected 1 space(s) after IF keyword; 0 found
 13 | ERROR   | [x] Expected 1 space(s) after closing parenthesis; found 0
 15 | WARNING | [ ] Line exceeds 120 characters; contains 164 characters
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

チエック（ [x] ）が入ったエラー/警告は、phpcbfで修正できる項目

同じファイルをPEARコーディング規約でチェックすると、全く違う結果となる

$ phpcs -v test.php 
Registering sniffs in the PEAR standard... DONE (28 sniffs registered)
Processing test.php [PHP => 56 tokens in 18 lines]... DONE in 1ms (9 errors, 2 warnings)
FILE: /home/user/test/test.php

--------------------------------------------------------------------------------
FOUND 9 ERRORS AND 2 WARNINGS AFFECTING 4 LINES
--------------------------------------------------------------------------------
  4 | ERROR   | [ ] Doc comment short description must start with a capital
    |         |     letter
  7 | WARNING | [ ] PHP version not specified
  7 | ERROR   | [ ] Missing @category tag in file comment
  7 | ERROR   | [ ] Missing @package tag in file comment
  7 | ERROR   | [ ] Missing @author tag in file comment
  7 | ERROR   | [ ] Missing @license tag in file comment
  7 | ERROR   | [ ] Missing @link tag in file comment
  7 | ERROR   | [x] Additional blank lines found at end of doc comment
 13 | ERROR   | [ ] Expected "if (...) {\n"; found "if(...){\n"
 13 | ERROR   | [x] There must be a single space between the closing
    |         |     parenthesis and the opening brace of a multi-line IF
    |         |     statement; found 0 spaces
 15 | WARNING | [ ] Line exceeds 85 characters; contains 164 characters
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------