Login
Add documentation about integrating perlcritic with Komodo.
authorJeffrey Ryan Thalhammer <jeff@imaginative-software.com>
Mon, 9 Apr 2007 01:38:28 +0000 (01:38 +0000)
committerJeffrey Ryan Thalhammer <jeff@imaginative-software.com>
Mon, 9 Apr 2007 01:38:28 +0000 (01:38 +0000)
bin/perlcritic
extras/KomodoIntegration.pod [new file with mode: 0644]

index a3a9057..6132042 100755 (executable)
@@ -1110,9 +1110,17 @@ myself, but other folks say it works.
 
 =head2 BBEdit
 
-Josh Clark has produced an excellent Perl-Critic plugin for BBEdit. See
-L<http://beta.bigmedium.com/projects/bbedit-perl-critic/index.shtml> for more
-information.  Apple users rejoice!
+Josh Clark has produced an excellent Perl-Critic plugin for BBEdit. A copy is
+included in this distro at F<extras/perl_critic_for_bbedit-1_0.zip>. See
+L<http://beta.bigmedium.com/projects/bbedit-perl-critic/index.shtml> for
+screenshots and additional installation info.  Apple users rejoice!
+
+=head2 Komodo
+
+Komodo is a proprietary IDE for Perl and several other dynamic languages.
+Free trial copies of Komodo can be obtained from the ActiveState website at
+L<http://www.activestate.com>. For instructions on integrating F<perlcritic>
+with Komodo, see F<extras/KomodoIntegration.pod> in this distro.
 
 =head1 EXIT STATUS
 
diff --git a/extras/KomodoIntegration.pod b/extras/KomodoIntegration.pod
new file mode 100644 (file)
index 0000000..101e981
--- /dev/null
@@ -0,0 +1,88 @@
+##############################################################################
+#      $URL$
+#     $Date: 2007-04-08 14:33:26 -0700 (Sun, 08 Apr 2007) $
+#   $Author: thaljef $
+# $Revision: 1403 $
+##############################################################################
+
+=head1 NAME
+
+KomodoIntegration - Integrating perlcritic and Komodo
+
+=head1 DESCRIPTION
+
+This document describes the steps for integrating F<perlcritic> with Komodo 4.0
+from ActiveState.  More information about Komodo can be found at
+L<http://www.activestate.com>
+
+These instructions assume that F<perlcritic> has been installed somewhere in
+your C<$PATH>.  If it is not in your C<$PATH>, you must give the full path to
+F<perlcritic> instead of using the C<-S> switch.  Also, I'm assuming that you
+have installed Perl-Critic with the same Perl that Komodo is using.  If that
+is not the case, you'll probably have to give a full path to F<perl> instead
+of using the C<%perl> placeholder.
+
+=over 4
+
+=item * Start Komodo.
+
+=item * Select C<< Toolbox -> Add -> New Command... >> from the menu.
+
+=item * Enter a name for the command (e.g. "perlcritic").
+
+=item * In the C<Command:> field, enter the following:
+
+  %perl -S perlcritic --severity=%(ask:Severity level [1-5]?:5) --verbose=1 %F
+
+=item * Uncheck the C<Insert output> and C<Pass selection as input> boxes.
+
+=item * In the C<Run in:> drop-down list, select C<Command Output Tab>.
+
+=item * Uncheck the C<Do not open output pane> box.
+
+=item * Check the C<Parse output with:> box, and type this into the field:
+
+  ^(?P<file>.+):(?P<line>.+):(?P<column>.+):(?P<content>.+)$
+
+=item * Check the C<Show parsed output as a list> box.
+
+=item * Click the C<Key Binding> tab.
+
+=item * Click the C<New Key Sequence> text field, and press C<Ctrl-Alt-p>.
+
+=item * Click the C<Add> button.
+
+=item * Click the C<OK> button.
+
+=back
+
+Now to run F<perlcritic> on the current file, just press C<Ctrl-Alt-p>, or
+select C<perlcritic> from the C<Toolbox> menu.  Each time, you will be
+prompted to enter the minimum severity level (defaulting to 5).  After a few
+moments, the output will appear in the C<Command Output> pane.  By
+double-clicking on the output messages, you can navigate to the appropriate
+point in the code.
+
+=head1 AUTHOR
+
+Jeffrey Ryan Thalhammer <thaljef@cpan.org>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2005-2007 Jeffrey Ryan Thalhammer.  All rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.  The full text of this license can be found in
+the LICENSE file included with this module.
+
+=cut
+
+##############################################################################
+# Local Variables:
+#   mode: cperl
+#   cperl-indent-level: 4
+#   fill-column: 78
+#   indent-tabs-mode: nil
+#   c-indentation-style: bsd
+# End:
+# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab :