/ 
App-CharmKit-0.016
River stage zero No dependents
/ App::CharmKit::Role::Lint

NAME

App::CharmKit::Role::Lint - charm linter

VERSION

version 0.016

SYNOPSIS

$ charmkit lint

DESCRIPTION

Performs various lint checks to make sure the charm is in accordance with Charm Store policies.

ATTRIBUTES

rules

Lint rules file

has_error

Stores whether or not a fatal error was found

METHODS

parse

Parses charm

validate_tests

Does basic sanity checking on tests directory

validate_configdata(HASHREF configdata)

Validates config.yaml

validate_metadata(HASHREF metadata)

Validates metadata.yaml

validate_hook(HASHREF hookmeta)

Validates charm hooks

validate_attributes(HASHREF filemeta)

Performs validation of file based on available attribute

lint_fatal(STR item, STR message)

Prints a FATAL lint message

lint_warn(STR item, STR message)

Prints a WARNING lint message

lint_info(STR item, STR message)

Prints a INFO lint message

lint_print(STR item, HASHREF error)

Prints out lint errors

Format of lint rules

Lint rules are loaded from lint_rules.yaml in the distributions share directory. The format for rules is as follows:

---
files:
  file:
    name: 'config.yaml'
    attributes:
      - NOT_EMPTY
      - EXISTS
  file:
    name: 'copyright'
    attributes:
      - NOT_EMPTY
      - EXISTS
    parse:
      - pattern: '^options:\s*\n'
        error: 'ERR_INVALID_COPYRIGHT'

Available Attributes

  • NOT_EMPTY

  • NOT_EXISTS

  • EXISTS

AUTHOR

Adam Stokes <adamjs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Adam Stokes.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.