shlint 0.1.1 → 0.1.2

data/README.md

@@ -22,3 +22,9 @@ shells if you're missing any.
 If you're a ruby user, can install using `gem install shlint`
 
 Any other nix platform, just drop the contents of `lib` into your `$PATH`
+
+## Resources
+
+* [Portable Shell Programming](http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell)
+* [How to make bash scripts work in dash](http://mywiki.wooledge.org/Bashism)
+* [POSIX shell specification](http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html)

data/lib/checkbashisms

@@ -1,18 +1,24 @@
 #! /usr/bin/perl -w
+
+# This script is essentially copied from /usr/share/lintian/checks/scripts,
+# which is:
+#   Copyright (C) 1998 Richard Braakman
+#   Copyright (C) 2002 Josip Rodin
+# This version is
+#   Copyright (C) 2003 Julian Gilbey
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
 #
-# checkbashisms.perl
-#
-# Version: 2.0.0.2
-# Date: 30th January 2011
-#
-# (C) Copyright 1998-2003 Richard Braakman, Josip Rodin and Julian Gilbey
-# Additional programming by Mark Hobley
-#
-# This script is based on source code taken from the lintian project
-#
-# This program can be redistributed under the terms of version 2 of the
-# GNU General Public Licence as published by the Free Software Foundation
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 use strict;
 use Getopt::Long;
@@ -30,9 +36,13 @@ in /bin/sh scripts.
 EOF
 
 my $version = <<"EOF";
-This is $progname version 2.0.0.1
-(C) Copyright 1998-2003 Richard Braakman, Josip Rodin and Julian Gilbey
-Additional programming by Mark Hobley
+This is $progname, from the Debian devscripts package, version ###VERSION###
+This code is copyright 2003 by Julian Gilbey <jdg\@debian.org>,
+based on original code which is copyright 1998 by Richard Braakman
+and copyright 2002 by Josip Rodin.
+This program comes with ABSOLUTELY NO WARRANTY.
+You are free to redistribute this code under the terms of the
+GNU General Public License, version 2, or (at your option) any later version.
 EOF
 
 my ($opt_echo, $opt_force, $opt_extra, $opt_posix);
@@ -60,8 +70,8 @@ $opt_echo = 1 if $opt_posix;
 my $status = 0;
 my $makefile = 0;
 my (%bashisms, %string_bashisms, %singlequote_bashisms);
-my $LEADIN = qr'(?:(?:^|[`&;(|{])\s*|(?:if|then|do|while|shell)\s+)';
 
+my $LEADIN = qr'(?:(?:^|[`&;(|{])\s*|(?:if|then|do|while|shell)\s+)';
 init_hashes;
 
 foreach my $filename (@ARGV) {
@@ -81,7 +91,7 @@ foreach my $filename (@ARGV) {
 	     . "$check_lines_count lines\n";
     }
 
-    unless (open C, '<', "$filename") {
+    unless (open C, '<', $filename) {
 	warn "cannot open script $filename for reading: $!\n";
 	$status |= 2;
 	next;
@@ -95,6 +105,7 @@ foreach my $filename (@ARGV) {
     my $found_rules = 0;
     my $buffered_orig_line = "";
     my $buffered_line = "";
+
     while (<C>) {
 	next unless ($check_lines_count == -1 or $. <= $check_lines_count);
 
@@ -111,11 +122,19 @@ foreach my $filename (@ARGV) {
 		}
 		next if $opt_force;
 
-		if ($interpreter !~ m,/(sh|ash|hsh|posh)$,) {
-		    warn "script $filename does not appear to be a /bin/sh script\n";
+		if ($interpreter =~ m,/bash$,) {
+		    warn "script $filename is already a bash script; skipping\n";
+		    $status |= 2;
+		    last;  # end this file
+		}
+		elsif ($interpreter !~ m,/(sh|posh)$,) {
+### ksh/zsh?
+		    warn "script $filename does not appear to be a /bin/sh script; skipping\n";
+		    $status |= 2;
+		    last;
 		}
 	    } else {
-		warn "script $filename does not appear to have a \#! interpreter line\n";
+		warn "script $filename does not appear to have a \#! interpreter line;\nyou may get strange results\n";
 	    }
 	}
 
@@ -134,10 +153,10 @@ foreach my $filename (@ARGV) {
 	# will be treated as part of the comment.
 	# s/^(?:.*?[^\\])?$quote_string(.*)$/$1/ if $quote_string ne "";
 
-        # skip comment lines
-        if (m,^\s*\#, && $quote_string eq '' && $buffered_line eq '' && $cat_string eq '') {
-            next;
-        }
+	# skip comment lines
+	if (m,^\s*\#, && $quote_string eq '' && $buffered_line eq '' && $cat_string eq '') {
+	    next;
+	}
 
 	# Remove quoted strings so we can more easily ignore comments
 	# inside them
@@ -156,17 +175,17 @@ foreach my $filename (@ARGV) {
 
 	# Handle line continuation
 	if (!$makefile && $cat_string eq '' && m/\\$/) {
-	  chop;
-	  $buffered_line .= $_;
-	  $buffered_orig_line .= $orig_line . "\n";
-	  next;
+	    chop;
+	    $buffered_line .= $_;
+	    $buffered_orig_line .= $orig_line . "\n";
+	    next;
 	}
 
 	if ($buffered_line ne '') {
-	  $_ = $buffered_line . $_;
-	  $orig_line = $buffered_orig_line . $orig_line;
-	  $buffered_line ='';
-	  $buffered_orig_line ='';
+	    $_ = $buffered_line . $_;
+	    $orig_line = $buffered_orig_line . $orig_line;
+	    $buffered_line ='';
+	    $buffered_orig_line ='';
 	}
 
 	if ($makefile) {
@@ -184,10 +203,10 @@ foreach my $filename (@ARGV) {
 		$_ = $1 if $1;
 	    } 
 
-	    # Fixes for makefiles by Raphael Geissert
 	    last if m%^\s*(override\s|export\s)?\s*SHELL\s*:?=\s*(/bin/)?bash\s*%;
-            # Remove "simple" target names
-            s/^[\w%.-]+(?:\s+[\w%.-]+)*::?//;
+
+	    # Remove "simple" target names
+	    s/^[\w%.-]+(?:\s+[\w%.-]+)*::?//;
 	    s/^\t//;
 	    s/(?<!\$)\$\((\w+)\)/\${$1}/g;
 	    s/(\$){2}/$1/g;
@@ -259,17 +278,17 @@ foreach my $filename (@ARGV) {
 		    my $otherquote = ($quote eq "\"" ? "\'" : "\"");
 
 		    # Remove balanced quotes and their content
-	            $templine =~ s/(^|[^\\\"](?:\\\\)*)\'[^\']*\'/$1/g;
-	            $templine =~ s/(^|[^\\\'](?:\\\\)*)\"(?:\\.|[^\\\"])+\"/$1/g;
-
-                    # Don't flag quotes that are themselves quoted
-                    # "a'b"
-                    $templine =~ s/$otherquote.*?$quote.*?$otherquote//g;
-                    # "\""
-                    $templine =~ s/(^|[^\\])$quote\\$quote$quote/$1/g;
-                    # \' or \"
-                    $templine =~ s/\\[\'\"]//g;
-                    my $count = () = $templine =~ /(^|(?!\\))$quote/g;
+		    $templine =~ s/(^|[^\\\"](?:\\\\)*)\'[^\']*\'/$1/g;
+		    $templine =~ s/(^|[^\\\'](?:\\\\)*)\"(?:\\.|[^\\\"])+\"/$1/g;
+
+		    # Don't flag quotes that are themselves quoted
+		    # "a'b"
+		    $templine =~ s/$otherquote.*?$quote.*?$otherquote//g;
+		    # "\""
+		    $templine =~ s/(^|[^\\])$quote\\$quote$quote/$1/g;
+		    # \' or \"
+		    $templine =~ s/\\[\'\"]//g;
+		    my $count = () = $templine =~ /(^|(?!\\))$quote/g;
 
 		    # If there's an odd number of non-escaped
 		    # quotes in the line it's almost certainly the
@@ -286,17 +305,17 @@ foreach my $filename (@ARGV) {
 	    # detect source (.) trying to pass args to the command it runs
 	    # The first expression weeds out '. "foo bar"'
 	    if (not $found and
-	        not m/$LEADIN\.\s+(\"[^\"]+\"|\'[^\']+\'|\$\([^)]+\)+(?:\/[^\s;]+)?)\s*(\&|\||\d?>|<|;|\Z)/
-	        and m/$LEADIN(\.\s+[^\s;\`:]+\s+([^\s;]+))/) {
-	        if ($2 =~ /^(\&|\||\d?>|<)/) {
-	            # everything is ok
-	            ;
-	        } else {
-	            $found = 1;
-	            $match = $1;
-	            $explanation = "sourced script with arguments";
-	            output_explanation($filename, $orig_line, $explanation);
-	        }
+		not m/$LEADIN\.\s+(\"[^\"]+\"|\'[^\']+\'|\$\([^)]+\)+(?:\/[^\s;]+)?)\s*(\&|\||\d?>|<|;|\Z)/
+		and m/$LEADIN(\.\s+[^\s;\`:]+\s+([^\s;]+))/) {
+		if ($2 =~ /^(\&|\||\d?>|<)/) {
+		    # everything is ok
+		    ;
+		} else {
+		    $found = 1;
+		    $match = $1;
+		    $explanation = "sourced script with arguments";
+		    output_explanation($filename, $orig_line, $explanation);
+		}
 	    }
 
 	    # Remove "quoted quotes". They're likely to be inside
@@ -362,7 +381,6 @@ foreach my $filename (@ARGV) {
 	    # double-quoted strings, so now remove those strings as well.
 	    $line =~ s/(^|[^\\\'](?:\\\\)*)\"(?:\\.|[^\\\"])+\"/$1""/g;
 	    $cat_line =~ s/(^|[^<\\\'-](?:\\\\)*)\"(?:\\.|[^\\\"])+\"/$1""/g;
-
 	    while (my ($re,$expl) = each %bashisms) {
 	        if ($line =~ m/($re)/) {
 		    $found = 1;
@@ -375,18 +393,19 @@ foreach my $filename (@ARGV) {
 	    # Only look for the beginning of a heredoc here, after we've
 	    # stripped out quoted material, to avoid false positives.
 	    if ($cat_line =~ m/(?:^|[^<])\<\<(\-?)\s*(?:[\\]?(\w+)|[\'\"](.*?)[\'\"])/) {
-                $cat_indented = ($1 && $1 eq '-')? 1 : 0;
-                $cat_string = $2;
-                $cat_string = $3 if not defined $cat_string;
+		$cat_indented = ($1 && $1 eq '-')? 1 : 0;
+		$cat_string = $2;
+		$cat_string = $3 if not defined $cat_string;
             }
-        }
+	}
     }
+
     warn "error: $filename:  Unterminated heredoc found, EOF reached. Wanted: <$cat_string>\n"
-        if ($cat_string ne '');
+	if ($cat_string ne '');
     warn "error: $filename: Unterminated quoted string found, EOF reached. Wanted: <$quote_string>\n"
-        if ($quote_string ne '');
+	if ($quote_string ne '');
     warn "error: $filename: EOF reached while on line continuation.\n"
-        if ($buffered_line ne '');
+	if ($buffered_line ne '');
 
     close C;
 }
@@ -463,10 +482,10 @@ sub script_is_evil_and_wrong {
 
 	    $ret = $. - 1;
 	    last;
-        } elsif (m~\@DPATCH\@~) {
-            $ret = $. - 1;
-            last;
-        }
+	} elsif (m~\@DPATCH\@~) {
+	    $ret = $. - 1;
+	    last;
+	}
 
     }
     close IN;
@@ -474,16 +493,15 @@ sub script_is_evil_and_wrong {
 }
 
 sub init_hashes {
-    my $LEADIN = qr'(?:(^|[`&;(|{])\s*|(if|then|do|while|shell)\s+)';
 
     %bashisms = (
 	qr'(?:^|\s+)function \w+(\s|\(|\Z)' => q<'function' is useless>,
-	$LEADIN . qr'select\s+\w+' =>     q<'select' is not portable>,
+	$LEADIN . qr'select\s+\w+' =>     q<'select' is not POSIX>,
 	qr'(test|-o|-a)\s*[^\s]+\s+==\s' => q<should be 'b = a'>,
 	qr'\[\s+[^\]]+\s+==\s' =>        q<should be 'b = a'>,
-	qr'\s\|\&' =>                    q<pipelining is not portable>,
+	qr'\s\|\&' =>                    q<pipelining is not POSIX>,
 	qr'[^\\\$]\{([^\s\\\}]*?,)+[^\\\}\s]*\}' => q<brace expansion>,
-        qr'\{\d+\.\.\d+\}' => q<brace expansion, should be $(seq a b)>,
+	qr'\{\d+\.\.\d+\}' =>          q<brace expansion, should be $(seq a b)>,
 	qr'(?:^|\s+)\w+\[\d+\]=' =>      q<bash arrays, H[0]>,
 	$LEADIN . qr'read\s+(?:-[a-qs-zA-Z\d-]+)' => q<read with option other than -r>,
 	$LEADIN . qr'read\s*(?:-\w+\s*)*(?:\".*?\"|[\'].*?[\'])?\s*(?:;|$)'
@@ -494,41 +512,36 @@ sub init_hashes {
 	qr'(?<![\$\(])\(\(.*\)\)' =>     q<'((' should be '$(('>,
 	qr'(?:^|\s+)(\[|test)\s+-a' =>            q<test with unary -a (should be -e)>,
 	qr'\&>' =>	               q<should be \>word 2\>&1>,
-	qr'(<\&|>\&)\s*((-|\d+)[^\s;|)}`&\\\\]|[^-\d\s]+(?<!\$)(?!\d))' =>	
+	qr'(<\&|>\&)\s*((-|\d+)[^\s;|)}`&\\\\]|[^-\d\s]+(?<!\$)(?!\d))' =>
 				       q<should be \>word 2\>&1>,
-	$LEADIN . qr'kill\s+-[^sl]\w*' => q<kill -[0-9] or -[A-Z]>,
-	$LEADIN . qr'trap\s+["\']?.*["\']?\s+.*[1-9]' => q<trap with signal numbers>,
-	$LEADIN . qr'trap\s+["\']?.*["\']?\s+.*ERR' => q<trap ERR>,
 	qr'\[\[(?!:)' => q<alternative test command ([[ foo ]] should be [ foo ])>,
 	qr'/dev/(tcp|udp)'	    => q</dev/(tcp|udp)>,
-        $LEADIN . qr'alias\s' =>       q<alias>,
-        $LEADIN . qr'unalias\s' =>     q<unalias>,
 	$LEADIN . qr'builtin\s' =>        q<builtin>,
 	$LEADIN . qr'caller\s' =>         q<caller>,
-	$LEADIN . qr'complete\s' =>       q<complete>,
 	$LEADIN . qr'compgen\s' =>        q<compgen>,
+	$LEADIN . qr'complete\s' =>       q<complete>,
 	$LEADIN . qr'declare\s' =>        q<declare>,
 	$LEADIN . qr'dirs(\s|\Z)' =>      q<dirs>,
 	$LEADIN . qr'disown\s' =>         q<disown>,
 	$LEADIN . qr'enable\s' =>         q<enable>,
-        $LEADIN . qr'export\s+-[^p]' =>  q<export only takes -p as an option>,
-        $LEADIN . qr'export\s+.+=' => q<export foo=bar should be foo=bar; export foo>,
 	$LEADIN . qr'mapfile\s' =>        q<mapfile>,
 	$LEADIN . qr'readarray\s' =>      q<readarray>,
-	$LEADIN . qr'readonly\s+-[af]' => q<readonly -[af]>,
-        $LEADIN . qr'(push|pop)d(\s|\Z)' =>    q<(push|pop)d>,
-        $LEADIN . qr'set\s+-[BHT]+' =>    q<set -[BHT]>,
 	$LEADIN . qr'shopt(\s|\Z)' =>     q<shopt>,
 	$LEADIN . qr'suspend\s' =>        q<suspend>,
 	$LEADIN . qr'time\s' =>           q<time>,
 	$LEADIN . qr'type\s' =>           q<type>,
-        $LEADIN . qr'typeset\s' =>        q<typeset>,
+	$LEADIN . qr'typeset\s' =>        q<typeset>,
 	$LEADIN . qr'ulimit(\s|\Z)' =>    q<ulimit>,
+	$LEADIN . qr'set\s+-[BHT]+' =>    q<set -[BHT]>,
+	$LEADIN . qr'alias\s+-p' =>       q<alias -p>,
+	$LEADIN . qr'unalias\s+-a' =>     q<unalias -a>,
 	$LEADIN . qr'local\s+-[a-zA-Z]+' => q<local -opt>,
 	qr'(?:^|\s+)\s*\(?\w*[^\(\w\s]+\S*?\s*\(\)\s*([\{|\(]|\Z)'
 		=> q<function names should only contain [a-z0-9_]>,
+	$LEADIN . qr'(push|pop)d(\s|\Z)' =>    q<(push|pop)d>,
+	$LEADIN . qr'export\s+-[^p]' =>  q<export only takes -p as an option>,
 	qr'(?:^|\s+)[<>]\(.*?\)'	    => q<\<() process substituion>,
-	qr'(?:^|\s+)readonly\s+-[af]' => q<readonly -[af]>,
+	$LEADIN . qr'readonly\s+-[af]' => q<readonly -[af]>,
 	$LEADIN . qr'(sh|\$\{?SHELL\}?) -[rD]' => q<sh -[rD]>,
 	$LEADIN . qr'(sh|\$\{?SHELL\}?) --\w+' =>  q<sh --long-option>,
 	$LEADIN . qr'(sh|\$\{?SHELL\}?) [-+]O' =>  q<sh [-+]O>,
@@ -536,11 +549,13 @@ sub init_hashes {
 	$LEADIN . qr'printf\s+-v' => q<'printf -v var ...' should be var='$(printf ...)'>,
 	$LEADIN . qr'coproc\s' =>        q<coproc>,
 	qr';;?&' =>  q<;;& and ;& special case operators>,
+	$LEADIN . qr'jobs\s' =>  q<jobs>,
+#	$LEADIN . qr'jobs\s+-[^lp]\s' =>  q<'jobs' with option other than -l or -p>,
+	$LEADIN . qr'command\s+-[^p]\s' =>  q<'command' with option other than -p>,
     );
 
     %string_bashisms = (
-        qr'\$\[[^][]+\]' =>            q<'$[' should be '$(('>,
-	qr'\$\[\w+\]' =>                 q<arithmetic not allowed>,
+	qr'\$\[[^][]+\]' =>	         q<'$[' should be '$(('>,
 	qr'\$\{\w+\:\d+(?::\d+)?\}' =>   q<${foo:3[:1]}>,
 	qr'\$\{!\w+[\@*]\}' =>           q<${!prefix[*|@]>,
 	qr'\$\{!\w+\}' =>                q<${!name}>,
@@ -552,27 +567,25 @@ sub init_hashes {
 	qr'\$\{?DIRSTACK\}?\b'        => q<$DIRSTACK>,
 	qr'\$\{?EUID\}?\b'	      => q<$EUID should be "$(id -u)">,
 	qr'\$\{?UID\}?\b'	       => q<$UID should be "$(id -ru)">,
-	qr'\$\{?LINENO\}?\b'	=> q<$LINENO>,
 	qr'\$\{?SECONDS\}?\b'	    => q<$SECONDS>,
 	qr'\$\{?BASH_[A-Z]+\}?\b'     => q<$BASH_SOMETHING>,
-        qr'\$\{?KSH_[A-Z]+\}?\b'     => q<$KSH_SOMETHING>,
 	qr'\$\{?SHELLOPTS\}?\b'       => q<$SHELLOPTS>,
 	qr'\$\{?PIPESTATUS\}?\b'      => q<$PIPESTATUS>,
 	qr'\$\{?SHLVL\}?\b'           => q<$SHLVL>,
 	qr'<<<'                       => q<\<\<\< here string>,
+	$LEADIN . qr'echo\s+(?:-[^e\s]+\s+)?\"[^\"]*(\\[abcEfnrtv0])+.*?[\"]' => q<unsafe echo with backslash>,
 	qr'\$\(\([\s\w$*/+-]*\w\+\+.*?\)\)'   => q<'$((n++))' should be '$n; $((n=n+1))'>,
 	qr'\$\(\([\s\w$*/+-]*\+\+\w.*?\)\)'   => q<'$((++n))' should be '$((n=n+1))'>,
 	qr'\$\(\([\s\w$*/+-]*\w\-\-.*?\)\)'   => q<'$((n--))' should be '$n; $((n=n-1))'>,
 	qr'\$\(\([\s\w$*/+-]*\-\-\w.*?\)\)'   => q<'$((--n))' should be '$((n=n-1))'>,
-        qr'\$\(\([\s\w$*/+-]*\*\*.*?\)\)'   => q<exponentiation is not POSIX>,
-	$LEADIN . qr'echo\s+(?:-[^e\s]+\s+)?\"[^\"]*(\\[abcEfnrtv0])+.*?[\"]' => q<unsafe echo with backslash>,
+	qr'\$\(\([\s\w$*/+-]*\*\*.*?\)\)'   => q<exponentiation is not POSIX>,
 	$LEADIN . qr'printf\s["\'][^"\']+?%[qb].+?["\']' => q<printf %q|%b>,
     );
 
     %singlequote_bashisms = (
 	$LEADIN . qr'echo\s+(?:-[^e\s]+\s+)?\'[^\']*(\\[abcEfnrtv0])+.*?[\']' => q<unsafe echo with backslash>,
-        $LEADIN . qr'source\s+[\"\']?(?:\.\/|\/|\$|[\w~.-])\S*' =>
-                                       q<should be '.', not 'source'>,
+	$LEADIN . qr'source\s+[\"\']?(?:\.\/|\/|\$|[\w~.-])\S*' =>
+	                               q<should be '.', not 'source'>,
     );
 
     if ($opt_echo) {
@@ -583,6 +596,8 @@ sub init_hashes {
 	$bashisms{$LEADIN . qr'local\s+\w+='} = q<local foo=bar>;
 	$bashisms{$LEADIN . qr'local\s+\w+\s+\w+'} = q<local x y>;
 	$bashisms{$LEADIN . qr'((?:test|\[)\s+.+\s-[ao])\s'} = q<test -a/-o>;
+	$bashisms{$LEADIN . qr'kill\s+-[^sl]\w*'} = q<kill -[0-9] or -[A-Z]>;
+	$bashisms{$LEADIN . qr'trap\s+["\']?.*["\']?\s+.*[1-9]'} = q<trap with signal numbers>;
     }
 
     if ($makefile) {
@@ -592,7 +607,7 @@ sub init_hashes {
 	$bashisms{$LEADIN . qr'\w+\+='} = q<should be VAR="${VAR}foo">;
 	$string_bashisms{qr'(\$\(|\`)\s*\<\s*\S+\s*(\)|\`)'} = q<'$(\< foo)' should be '$(cat foo)'>;
     }
-	    
+
     if ($opt_extra) {
 	$string_bashisms{qr'\$\{?BASH\}?\b'} = q<$BASH>;
 	$string_bashisms{qr'(?:^|\s+)RANDOM='} = q<RANDOM=>;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shlint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Checks the syntax of your shellscript against known and available shells.
 email: