/ 
App-ShellCheckWiki-0.03
River stage zero No dependents
/ App::ShellCheckWiki

NAME

App::ShellCheckWiki - Check the wiki for details about shellcheck errors.

VERSION

Version 0.03

SYNOPSIS

Check the official ShellCheck wiki page for detailed shellcheck error info.

# Show the wiki in the terminal for ShellCheck Error SC1234
$ shellcheckwiki 1234

# Show List of all Errors documented in the wiki
$ shellcheckwiki

INSPIRATION

ShellCheck is a static analysis tool for shell scripts.  Available from
L<Github|https://github.com/koalaman/shellcheck> with an online demo at
L<shellcheck.net|https://www.shellcheck.net/>.

Think of it as the perlcritic for shell scripts.  It produces useful, but
terse error messages with an error code, like SC1234.  There is a
long-form description of most of these messages available on the
L<github wiki page|https://github.com/koalaman/shellcheck/wiki>.

The shellcheckwiki script can be used to fetch and display in the terminal
a specific page or a table of contents, all from the comfort of the command
line.

DEMO

See shellcheckwiki in action at L<asciinema|https://asciinema.org/a/J0z2MZTJe8iesCGk2OsEL3sWb>

AUTHOR

Felix Tubiana, <felixtubiana at gmail.com>

BUGS

Please report any bugs or feature requests to bug-app-shellcheckwiki at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-ShellCheckWiki. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc App::ShellCheckWiki

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2018 Felix Tubiana.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (1.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_1_0

Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package.

The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.