App::CharmKit::Role::Lint - charm linter
version 0.18
$ charmkit lint
Performs various lint checks to make sure the charm is in accordance with Charm Store policies.
Lint rules file
Stores whether or not a fatal error was found
Parses charm
Does basic sanity checking on tests directory
Validates config.yaml
Validates metadata.yaml
Validates charm hooks
Performs validation of file based on available attribute
Prints a FATAL lint message
Prints a WARNING lint message
Prints a INFO lint message
Prints out lint errors
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'
NOT_EMPTY
NOT_EXISTS
EXISTS
Adam Stokes <adamjs@cpan.org>
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.
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.
To install App::CharmKit, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CharmKit
CPAN shell
perl -MCPAN -e shell install App::CharmKit
For more information on module installation, please visit the detailed CPAN module installation guide.