xref: /freebsd/contrib/kyua/admin/check-style-shell.awk (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1*b0d29bc4SBrooks Davis# Copyright 2015 The Kyua Authors.
2*b0d29bc4SBrooks Davis# All rights reserved.
3*b0d29bc4SBrooks Davis#
4*b0d29bc4SBrooks Davis# Redistribution and use in source and binary forms, with or without
5*b0d29bc4SBrooks Davis# modification, are permitted provided that the following conditions are
6*b0d29bc4SBrooks Davis# met:
7*b0d29bc4SBrooks Davis#
8*b0d29bc4SBrooks Davis# * Redistributions of source code must retain the above copyright
9*b0d29bc4SBrooks Davis#   notice, this list of conditions and the following disclaimer.
10*b0d29bc4SBrooks Davis# * Redistributions in binary form must reproduce the above copyright
11*b0d29bc4SBrooks Davis#   notice, this list of conditions and the following disclaimer in the
12*b0d29bc4SBrooks Davis#   documentation and/or other materials provided with the distribution.
13*b0d29bc4SBrooks Davis# * Neither the name of Google Inc. nor the names of its contributors
14*b0d29bc4SBrooks Davis#   may be used to endorse or promote products derived from this software
15*b0d29bc4SBrooks Davis#   without specific prior written permission.
16*b0d29bc4SBrooks Davis#
17*b0d29bc4SBrooks Davis# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*b0d29bc4SBrooks Davis# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*b0d29bc4SBrooks Davis# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*b0d29bc4SBrooks Davis# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*b0d29bc4SBrooks Davis# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*b0d29bc4SBrooks Davis# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*b0d29bc4SBrooks Davis# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*b0d29bc4SBrooks Davis# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*b0d29bc4SBrooks Davis# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*b0d29bc4SBrooks Davis# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*b0d29bc4SBrooks Davis# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*b0d29bc4SBrooks Davis
29*b0d29bc4SBrooks Davisfunction warn(msg) {
30*b0d29bc4SBrooks Davis    print FILENAME "[" FNR "]: " msg > "/dev/stderr"
31*b0d29bc4SBrooks Davis    error = 1
32*b0d29bc4SBrooks Davis}
33*b0d29bc4SBrooks Davis
34*b0d29bc4SBrooks DavisBEGIN {
35*b0d29bc4SBrooks Davis    skip = 0
36*b0d29bc4SBrooks Davis    error = 0
37*b0d29bc4SBrooks Davis}
38*b0d29bc4SBrooks Davis
39*b0d29bc4SBrooks Davis/CHECK_STYLE_DISABLE/ {
40*b0d29bc4SBrooks Davis    skip = 1
41*b0d29bc4SBrooks Davis    next
42*b0d29bc4SBrooks Davis}
43*b0d29bc4SBrooks Davis
44*b0d29bc4SBrooks Davis/CHECK_STYLE_ENABLE/ {
45*b0d29bc4SBrooks Davis    skip = 0
46*b0d29bc4SBrooks Davis    next
47*b0d29bc4SBrooks Davis}
48*b0d29bc4SBrooks Davis
49*b0d29bc4SBrooks Davis/CHECK_STYLE_(ENABLE|DISABLE)/ {
50*b0d29bc4SBrooks Davis    next
51*b0d29bc4SBrooks Davis}
52*b0d29bc4SBrooks Davis
53*b0d29bc4SBrooks Davis{
54*b0d29bc4SBrooks Davis    if (skip)
55*b0d29bc4SBrooks Davis        next
56*b0d29bc4SBrooks Davis}
57*b0d29bc4SBrooks Davis
58*b0d29bc4SBrooks Davis/^[ \t]*#/ {
59*b0d29bc4SBrooks Davis    next
60*b0d29bc4SBrooks Davis}
61*b0d29bc4SBrooks Davis
62*b0d29bc4SBrooks Davis/[$ \t]+_[a-zA-Z0-9]+=/ {
63*b0d29bc4SBrooks Davis    warn("Variable should not start with an underline")
64*b0d29bc4SBrooks Davis}
65*b0d29bc4SBrooks Davis
66*b0d29bc4SBrooks Davis/[^\\]\$[^0-9!'"$?@#*{}(|\/,]+/ {
67*b0d29bc4SBrooks Davis    warn("Missing braces around variable name")
68*b0d29bc4SBrooks Davis}
69*b0d29bc4SBrooks Davis
70*b0d29bc4SBrooks Davis/=(""|'')/ {
71*b0d29bc4SBrooks Davis    warn("Assignment to the empty string does not need quotes");
72*b0d29bc4SBrooks Davis}
73*b0d29bc4SBrooks Davis
74*b0d29bc4SBrooks Davis/basename[ \t]+/ {
75*b0d29bc4SBrooks Davis    warn("Use parameter expansion instead of basename");
76*b0d29bc4SBrooks Davis}
77*b0d29bc4SBrooks Davis
78*b0d29bc4SBrooks Davis/if[ \t]+(test|![ \t]+test)/ {
79*b0d29bc4SBrooks Davis    warn("Use [ instead of test");
80*b0d29bc4SBrooks Davis}
81*b0d29bc4SBrooks Davis
82*b0d29bc4SBrooks Davis/[ \t]+(test|\[).*==/ {
83*b0d29bc4SBrooks Davis    warn("test(1)'s == operator is not portable");
84*b0d29bc4SBrooks Davis}
85*b0d29bc4SBrooks Davis
86*b0d29bc4SBrooks Davis/if.*;[ \t]*fi$/ {
87*b0d29bc4SBrooks Davis    warn("Avoid using a single-line if conditional");
88*b0d29bc4SBrooks Davis}
89*b0d29bc4SBrooks Davis
90*b0d29bc4SBrooks DavisEND {
91*b0d29bc4SBrooks Davis    if (skip)
92*b0d29bc4SBrooks Davis        warn("Missing CHECK_STYLE_ENABLE");
93*b0d29bc4SBrooks Davis    if (error)
94*b0d29bc4SBrooks Davis        exit 1
95*b0d29bc4SBrooks Davis}
96