vcs.maemo.org Git - dh-make-perl/blob - dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/extras/KomodoIntegration.pod

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/extras/KomodoIntegration.pod $
   3 #     $Date: 2008-06-22 11:08:37 -0700 (Sun, 22 Jun 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2467 $
   6 ##############################################################################
   7
   8 =head1 NAME
   9
  10 KomodoIntegration - Integrating perlcritic and Komodo.
  11
  12 =head1 DESCRIPTION
  13
  14 This document describes the steps for integrating F<perlcritic> with Komodo 4.0
  15 from ActiveState.  More information about Komodo can be found at
  16 L<http://www.activestate.com>
  17
  18 These instructions assume that F<perlcritic> has been installed somewhere in
  19 your C<$PATH>.  If it is not in your C<$PATH>, you must give the full path to
  20 F<perlcritic> instead of using the C<-S> switch.  Also, I'm assuming that you
  21 have installed Perl-Critic with the same Perl that Komodo is using.  If that
  22 is not the case, you'll probably have to give a full path to F<perl> instead
  23 of using the C<%perl> placeholder.
  24
  25 =over 4
  26
  27 =item * Start Komodo.
  28
  29 =item * Select C<< Toolbox -> Add -> New Command... >> from the menu.
  30
  31 =item * Enter a name for the command (e.g. "perlcritic").
  32
  33 =item * In the C<Command:> field, enter the following:
  34
  35   %perl -S perlcritic --severity=%(ask:Severity level [1-5]?:5) --verbose=1 %F
  36
  37 =item * Uncheck the C<Insert output> and C<Pass selection as input> boxes.
  38
  39 =item * In the C<Run in:> drop-down list, select C<Command Output Tab>.
  40
  41 =item * Uncheck the C<Do not open output pane> box.
  42
  43 =item * Check the C<Parse output with:> box, and type this into the field:
  44
  45   ^(?P<file>.+):(?P<line>.+):(?P<column>.+):(?P<content>.+)$
  46
  47 =item * Check the C<Show parsed output as a list> box.
  48
  49 =item * Click the C<Key Binding> tab.
  50
  51 =item * Click the C<New Key Sequence> text field, and press C<Ctrl-Alt-p>.
  52
  53 =item * Click the C<Add> button.
  54
  55 =item * Click the C<OK> button.
  56
  57 =back
  58
  59 Now to run F<perlcritic> on the current file, just press C<Ctrl-Alt-p>, or
  60 select C<perlcritic> from the C<Toolbox> menu.  Each time, you will be
  61 prompted to enter the minimum severity level (defaulting to 5).  After a few
  62 moments, the output will appear in the C<Command Output> pane.  By
  63 double-clicking on the output messages, you can navigate to the appropriate
  64 point in the code.
  65
  66 =head1 AUTHOR
  67
  68 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  69
  70 =head1 COPYRIGHT
  71
  72 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  73
  74 This program is free software; you can redistribute it and/or modify it under
  75 the same terms as Perl itself.  The full text of this license can be found in
  76 the LICENSE file included with this module.
  77
  78 =cut
  79
  80 ##############################################################################
  81 # Local Variables:
  82 #   mode: cperl
  83 #   cperl-indent-level: 4
  84 #   fill-column: 78
  85 #   indent-tabs-mode: nil
  86 #   c-indentation-style: bsd
  87 # End:
  88 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :