basic-perl-template-for-cli/design_methodology.txt at master · kimmel/basic-perl-template-for-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Design Methodology
==================

Code Formatting:
----------------

perltidy -pbp


Code Design:
------------

One of the basic ideas was to use perlcritic and existing policies to help
make the code uniform. Below are a list of the themes and modes used.

swift - Perl::Critic::Swift
security
complexity
portability
unicode
bangs - Perl::Critic::Bangs
performance
tests
--harsh
pbp
--brutal

Instead of spending an undue amount of time explaining why all of the above
are worthwhile I am just going to list the policy warnings I do not adhere to:

pbp:
  RCS keywords $Id$ not found
  RCS keywords $Revision$, $HeadURL$, $Date$ not found
  RCS keywords $Revision$, $Source$, $Date$
  Postfix control "unless" used
    * Sometimes an unless statement is more readable.
    main() if (! caller); # is not that clear
    main() unless caller; # nice and clean


Core Modules:
-------------

Exploit everything you can that comes with a Perl distro. corelist is an
excellent command line tool for checking if a module is in core.


References used:
----------------

perltidy command-line interface -
  perldoc perltidy / http://perltidy.sourceforge.net/

perlcritic command-line interface -
  perldoc perlcritic / http://search.cpan.org/dist/Perl-Critic/bin/perlcritic

Perl Best Practices by Damian Conway