NAME

App::Critique::Command::init - Initialize critique session file

VERSION

version 0.03

DESCRIPTION

This command will create a critique session file in your ~/.critique directory (including creating the ~/.critique directory if needed). This file will be used to store information about the critque session, such as the set of files you wish to critique and your progress in processing the set.

The specific file path for the critique session will be based on the information provided through the command line options, and will look something like this:

  ~/.critique/<git-repo>/<git-branch>/session.json

The value of git-repo will be surmised from the git-work-tree which itself defaults to finding the root of the git working directory via your current working directory.

The value of git-branch comes directly from the command line option, or will default itself to the currently active git branch.

You must also supply Perl::Critic informaton must be specified, either as a Perl::Critic profile config (ex: perlcriticrc) with additional Perl::Critic 'theme' expression added. Alternatively you can just specify a single Perl::Critic::Policy to use during the critique session. If no Perl::Critic specific options are detected, then we will do whatever is the default for Perl::Critic, which currently is to use all the available policies with their default configuration.

AUTHOR

Stevan Little <stevan@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Stevan Little.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.