Perl Linting and Formatting

Perl代码检查与格式化

Run Perl::Critic analysis and perltidy formatting with automatic tool detection.

自动检测工具，运行Perl::Critic分析和perltidy格式化。

Workflow

工作流

Check if perlcritic/perltidy are installed
Run analysis on specified files
Report findings with severity levels
Suggest fixes or format code

检查perlcritic/perltidy是否已安装
对指定文件运行分析
按严重级别报告发现的问题
提供修复建议或格式化代码

Tool Detection

工具检测

First, verify tools are available:

bash

undefined

首先验证工具是否可用：

bash

undefined

Check perlcritic

command -v perlcritic >/dev/null && echo "perlcritic available" || echo "Install: cpanm Perl::Critic"

Check perltidy

command -v perltidy >/dev/null && echo "perltidy available" || echo "Install: cpanm Perl::Tidy"

undefined

command -v perltidy >/dev/null && echo "perltidy available" || echo "Install: cpanm Perl::Tidy"

undefined

Perl::Critic Analysis

Perl::Critic分析

Running perlcritic

运行perlcritic

bash

undefined

bash

undefined

Default analysis (severity 5 - gentle)

perlcritic script.pl

All severities (1 = strictest)

perlcritic --severity 1 script.pl

Specific severity level

perlcritic --severity 3 script.pl

With verbose explanations

perlcritic --verbose 11 script.pl

Single policy

perlcritic --single-policy RequireUseStrict script.pl

Exclude policies

perlcritic --exclude RequireUseWarnings script.pl

undefined

perlcritic --exclude RequireUseWarnings script.pl

undefined

Severity Levels

严重级别

Level	Name	Description
5	Gentle	Obvious, unambiguous issues
4	Stern	Usually bad practices
3	Harsh	Controversial but recommended
2	Cruel	Pickier about style
1	Brutal	Maximum strictness

级别	名称	描述
5	温和	明显、无歧义的问题
4	严格	通常属于不良实践
3	苛刻	存在争议但仍推荐遵循
2	严苛	对代码风格要求更高
1	最高严格	最大严格度

Common Policies

常用规则

Policy	Severity	Issue
RequireUseStrict	5	Missing `use strict`
RequireUseWarnings	4	Missing `use warnings`
ProhibitBarewordFileHandles	5	Using bareword filehandles
ProhibitTwoArgOpen	5	Two-argument open()
ProhibitStringyEval	5	Using eval with string
RequireTidyCode	1	Code not formatted

规则名称	严重级别	问题
RequireUseStrict	5	缺少 `use strict` 声明
RequireUseWarnings	4	缺少 `use warnings` 声明
ProhibitBarewordFileHandles	5	使用了裸字文件句柄
ProhibitTwoArgOpen	5	使用了双参数形式的open()
ProhibitStringyEval	5	对字符串使用eval
RequireTidyCode	1	代码未格式化

Configuration File

配置文件

Create

.perlcriticrc

in project root:

ini

undefined

在项目根目录创建

.perlcriticrc

：

ini

undefined

.perlcriticrc

severity = 3 verbose = 8 theme = core

Exclude specific policies

[-Documentation::RequirePodSections] [-InputOutput::RequireBriefOpen]

Configure specific policy

[CodeLayout::RequireTidyCode] perltidyrc = .perltidyrc

[Variables::ProhibitPackageVars] packages = Data::Dumper File::Find

[TestingAndDebugging::ProhibitNoStrict] allow = refs

undefined

[CodeLayout::RequireTidyCode] perltidyrc = .perltidyrc

[Variables::ProhibitPackageVars] packages = Data::Dumper File::Find

[TestingAndDebugging::ProhibitNoStrict] allow = refs

undefined

Verbose Formats

详细输出格式

Level	Output Format
1	Line only
4	Line + Column
8	Line + Policy + Severity
10	Full explanation
11	With PBP page reference

级别	输出格式
1	仅显示行号
4	行号 + 列号
8	行号 + 规则名称 + 严重级别
10	完整解释
11	附带PBP页面引用

Perltidy Formatting

Perltidy格式化

Basic Usage

基础用法

bash

undefined

bash

undefined

Format file (creates .bak backup)

perltidy script.pl

Format to stdout (no backup)

perltidy -st script.pl

In-place edit (no backup)

perltidy -b -nst script.pl

Check if tidy (exit code)

perltidy -st script.pl | diff -q - script.pl

undefined

perltidy -st script.pl | diff -q - script.pl

undefined

Common Options

常用选项

bash

undefined

bash

undefined

Basic formatting

perltidy -i=4 -ci=4 -l=100 script.pl

Full command with common options

perltidy
--indent-columns=4
--continuation-indentation=4
--maximum-line-length=100
--vertical-tightness=2
--paren-tightness=1
--brace-tightness=1
script.pl

undefined

perltidy
--indent-columns=4
--continuation-indentation=4
--maximum-line-length=100
--vertical-tightness=2
--paren-tightness=1
--brace-tightness=1
script.pl

undefined

Configuration File

配置文件

Create

.perltidyrc

in project root:

text

undefined

在项目根目录创建

.perltidyrc

：

text

undefined

.perltidyrc

Indentation

--indent-columns=4 --continuation-indentation=4

Line length

--maximum-line-length=100

Blank lines

--blank-lines-before-subs=1 --blank-lines-after-block-opening=0

Spaces

--paren-tightness=1 --brace-tightness=1 --square-bracket-tightness=1

Vertical alignment

--no-outdent-long-quotes --no-outdent-long-comments

Output

--backup-and-modify-in-place --backup-file-extension=/

undefined

--backup-and-modify-in-place --backup-file-extension=/

undefined

Combined Workflow

组合工作流

Lint and Fix

检查并修复

bash

#!/bin/bash

bash

#!/bin/bash

lint-perl.sh

FILE="$1"

if [[ ! -f "$FILE" ]]; then echo "Usage: lint-perl.sh <file.pl>" exit 1 fi

echo "=== Syntax Check ===" perl -c "$FILE" || exit 1

echo "" echo "=== Perl::Critic ===" if command -v perlcritic >/dev/null; then perlcritic --severity 4 "$FILE" else echo "perlcritic not installed. Run: cpanm Perl::Critic" fi

echo "" echo "=== Formatting Check ===" if command -v perltidy >/dev/null; then if ! perltidy -st "$FILE" | diff -q - "$FILE" >/dev/null 2>&1; then echo "File needs formatting. Run: perltidy $FILE" else echo "File is properly formatted." fi else echo "perltidy not installed. Run: cpanm Perl::Tidy" fi

undefined

FILE="$1"

if [[ ! -f "$FILE" ]]; then echo "Usage: lint-perl.sh <file.pl>" exit 1 fi

echo "=== Syntax Check ===" perl -c "$FILE" || exit 1

echo "" echo "=== Perl::Critic ===" if command -v perlcritic >/dev/null; then perlcritic --severity 4 "$FILE" else echo "perlcritic not installed. Run: cpanm Perl::Critic" fi

echo "" echo "=== Formatting Check ===" if command -v perltidy >/dev/null; then if ! perltidy -st "$FILE" | diff -q - "$FILE" >/dev/null 2>&1; then echo "File needs formatting. Run: perltidy $FILE" else echo "File is properly formatted." fi else echo "perltidy not installed. Run: cpanm Perl::Tidy" fi

undefined

Interpreting Results

结果解读

Severity 5 (Critical)

严重级别5（临界）

Must fix immediately:

text

Bareword file handle opened at line 10, column 1.
Two-argument "open" used at line 15, column 5.

Fix:

perl

undefined

必须立即修复：

text

Bareword file handle opened at line 10, column 1.
Two-argument "open" used at line 15, column 5.

修复方案：

perl

undefined

Wrong

open FILE, $filename;

Correct

open my $fh, '<', $filename;

undefined

open my $fh, '<', $filename;

undefined

Severity 4 (Important)

严重级别4（重要）

Should fix:

text

Code before strictures are enabled at line 1.

Fix:

perl

undefined

应该修复：

text

Code before strictures are enabled at line 1.

修复方案：

perl

undefined

Add at top

use strict; use warnings;

undefined

use strict; use warnings;

undefined

Severity 3 (Recommended)

严重级别3（推荐）

Consider fixing:

text

Regular expression without "/x" flag at line 25.

建议考虑修复：

text

Regular expression without "/x" flag at line 25.

Installation

安装

If tools are missing:

bash

undefined

如果缺少工具：

bash

undefined

Install both tools

cpanm Perl::Critic Perl::Tidy

Verify installation

perlcritic --version perltidy --version

undefined

perlcritic --version perltidy --version

undefined

Quick Commands

快捷命令

Lint specific file:

bash

perlcritic --severity 4 --verbose 8 path/to/file.pl

Lint all Perl files in directory:

bash

find . -name '*.pl' -o -name '*.pm' | xargs perlcritic --severity 4

Format all files:

bash

find . -name '*.pl' -o -name '*.pm' | xargs perltidy -b

检查指定文件：

bash

perlcritic --severity 4 --verbose 8 path/to/file.pl

检查目录下所有Perl文件：

bash

find . -name '*.pl' -o -name '*.pm' | xargs perlcritic --severity 4

格式化所有文件：

bash

find . -name '*.pl' -o -name '*.pm' | xargs perltidy -b

perl-lint

Original

Translation

Perl Linting and Formatting

Perl代码检查与格式化

Workflow

工作流

Tool Detection

工具检测

Check perlcritic

Check perlcritic

Check perltidy

Check perltidy

Perl::Critic Analysis

Perl::Critic分析

Running perlcritic

运行perlcritic

Default analysis (severity 5 - gentle)

Default analysis (severity 5 - gentle)

All severities (1 = strictest)

All severities (1 = strictest)

Specific severity level

Specific severity level

With verbose explanations

With verbose explanations

Single policy

Single policy

Exclude policies

Exclude policies

Severity Levels

严重级别

Common Policies

常用规则

Configuration File

配置文件

.perlcriticrc

.perlcriticrc

Exclude specific policies

Exclude specific policies

Configure specific policy

Configure specific policy

Verbose Formats

详细输出格式

Perltidy Formatting

Perltidy格式化

Basic Usage

基础用法

Format file (creates .bak backup)

Format file (creates .bak backup)

Format to stdout (no backup)

Format to stdout (no backup)

In-place edit (no backup)

In-place edit (no backup)

Check if tidy (exit code)

Check if tidy (exit code)

Common Options

常用选项

Basic formatting

Basic formatting

Full command with common options

Full command with common options

Configuration File

配置文件

.perltidyrc

.perltidyrc

Indentation

Indentation

Line length

Line length

Blank lines

Blank lines

Spaces

Spaces

Vertical alignment

Vertical alignment

Output

Output

Combined Workflow

组合工作流

Lint and Fix