/ 
App-CriticDB-0.0.4
/ App::CriticDB

NAME

App::CriticDB - Manage a database of Perl::Critic violations

VERSION

Version 0.0.4

SYNOPSIS

use App::CriticDB;
my $criticdb=App::CriticDB->new(
  ...
);
$criticdb->collect(pathspec, ...);
$criticdb->report();

Or called via commandline

perlcriticdb --file=filename.stor --profile=perlcritic.rc /path/to/files

DESCRIPTION

The perlcriticdb tool finds and retains Perl::Critic violations for a large repository of files, permits updates per file, and quick reporting of policy counts without the large runtimes of the main perlcritic command.

STORAGE ENGINES

Violation data can be stored on disk.

File

Perl::Critic violations may be stored in a local file:

my $criticdb=App::CriticDB->new(file=>'violations.stor',type=>'storable');
$criticdb->collect('/path/to/lib');

The type may be:

storable   Storable (default)
dump       Data::Dumper (not yet available)

Note that Data::Dumper files can be useful for debugging purposes but are not recommended for long term use, as they can be 10--30x slower for read/write operations.

REPORTING

Output similar to perlcritic can be produced by calling as

$criticdb->report(verbose=>'... format ...')

This supports both numeric and the string format specifiers from perlcritic.

Currently only reporting to STDOUT is supported.

FILE UPDATES

Detecting file updates

Violations are stored together with the current mtime for each file. On subsequent scans, files will be skipped unless their on-disk mtime exceeds the previous value.

File deletions

The collector will re-verify the existence of all files at the beginning of each run. Files that no longer exist are removed from the datastore.

TODO

Collection

Newer file discovery: Add support for any combination of timestamp/filesize/MD5 method for determining files that need scanned.

File deletion currently always happens. Add an option to retain missing files.

Storage

DBD::*. Plain file input (such as the lines produced by perlcritic normally).

Reporting

Support named-module hooks that handle each violation. This will be useful for filename remapping, addition of org-specific data, and rerouting to metrics collectors.

Behavior of "OK" files is not currently defined, as the datastore retains violations only.

Commandline tool

The script should support filter/selection similar to `perlcritic`, specifically severity selection and include/exclude. File aggregation may also be useful, but should not be the default. Support a --nodelete option to prevent removal of missing files.

From the commandline, the profile must always be specified, which permits migration to new profiles. In the common use case, however, the profile file should likely be retained in the datastore so subsequent execution can be performed without the explicit commandline argument.

SEE ALSO

Perl::Critic

AUTHORS

Brian Blackmore (brian@mediaalpha.com).

COPYRIGHT

Copyright (c) 2025--2035, MediaAlpha.com.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License Version 3 as published by the Free Software Foundation.