xref: /openbmc/openbmc-build-scripts/scripts/format-code.sh (revision e91217edf290aaa84f87305f3d4ec9afc21f9dc2) 
1#!/bin/bash
2set -e
3
4# This script reformats source files using various formatters and linters.
5#
6# Files are changed in-place, so make sure you don't have anything open in an
7# editor, and you may want to commit before formatting in case of awryness.
8#
9# This must be run on a clean repository to succeed
10#
11function display_help()
12{
13    echo "usage: format-code.sh [-h | --help] [--no-diff] [--list-tools]"
14    echo "                      [--disable <tool>] [--enable <tool>] [<path>]"
15    echo
16    echo "Format and lint a repository."
17    echo
18    echo "Arguments:"
19    echo "    --list-tools      Display available linters and formatters"
20    echo "    --no-diff         Don't show final diff output"
21    echo "    --disable <tool>  Disable linter"
22    echo "    --enable <tool>   Enable only specific linters"
23    echo "    --allow-missing   Run even if linters are not all present"
24    echo "    path              Path to git repository (default to pwd)"
25}
26
27LINTERS_ALL=( \
28        commit_gitlint \
29        commit_spelling \
30        beautysh \
31        beautysh_sh \
32        black \
33        clang_format \
34        clang_tidy \
35        eslint \
36        flake8 \
37        isort \
38        markdownlint \
39        meson \
40        prettier \
41        shellcheck \
42    )
43LINTERS_DISABLED=()
44LINTERS_ENABLED=()
45declare -A LINTERS_FAILED=()
46
47eval set -- "$(getopt -o 'h' --long 'help,list-tools,no-diff,disable:,enable:,allow-missing' -n 'format-code.sh' -- "$@")"
48while true; do
49    case "$1" in
50        '-h'|'--help')
51            display_help && exit 0
52            ;;
53
54        '--list-tools')
55            echo "Available tools:"
56            for t in "${LINTERS_ALL[@]}"; do
57                echo "    $t"
58            done
59            exit 0
60            ;;
61
62        '--no-diff')
63            OPTION_NO_DIFF=1
64            shift
65            ;;
66
67        '--disable')
68            LINTERS_DISABLED+=("$2")
69            shift && shift
70            ;;
71
72        '--enable')
73            LINTERS_ENABLED+=("$2")
74            shift && shift
75            ;;
76
77        '--allow-missing')
78            ALLOW_MISSING=yes
79            shift
80            ;;
81
82        '--')
83            shift
84            break
85            ;;
86
87        *)
88            echo "unknown option: $1"
89            display_help && exit 1
90            ;;
91    esac
92done
93
94# Detect tty and set nicer colors.
95if [ -t 1 ]; then
96    BLUE="\e[34m"
97    GREEN="\e[32m"
98    NORMAL="\e[0m"
99    RED="\e[31m"
100    YELLOW="\e[33m"
101else # non-tty, no escapes.
102    BLUE=""
103    GREEN=""
104    NORMAL=""
105    RED=""
106    YELLOW=""
107fi
108
109# Allow called scripts to know which clang format we are using
110export CLANG_FORMAT="clang-format"
111
112# Path to default config files for linters.
113CONFIG_PATH="$(git -C "$(dirname "${BASH_SOURCE[0]}")" rev-parse --show-toplevel)/config"
114TOOLS_PATH="$(git -C "$(dirname "${BASH_SOURCE[0]}")" rev-parse --show-toplevel)/tools"
115
116
117# Find repository root for `pwd` or $1.
118if [ -z "$1" ]; then
119    DIR="$(git rev-parse --show-toplevel || pwd)"
120else
121    DIR="$(git -C "$1" rev-parse --show-toplevel)"
122fi
123if [ ! -e "$DIR/.git" ]; then
124    echo -e "${RED}Error:${NORMAL} Directory ($DIR) does not appear to be a git repository"
125    exit 1
126fi
127
128cd "${DIR}"
129echo -e "    ${BLUE}Formatting code under${NORMAL} $DIR"
130
131# Config hashes:
132#   LINTER_REQUIRE - The requirements to run a linter, semi-colon separated.
133#       1. Executable.
134#       2. [optional] Configuration file.
135#       3. [optional] Global fallback configuration file.
136#
137#   LINTER_IGNORE - An optional set of semi-colon separated ignore-files
138#       specific to the linter.
139#
140#   LINTER_TYPES - The file types supported by the linter, semi-colon separated.
141#
142#   LINTER_CONFIG - The config (from LINTER_REQUIRE) chosen for the repository.
143#
144declare -A LINTER_REQUIRE=()
145declare -A LINTER_IGNORE=()
146declare -A LINTER_TYPES=()
147declare -A LINTER_CONFIG=()
148
149LINTER_REQUIRE+=([commit_spelling]="codespell")
150LINTER_TYPES+=([commit_spelling]="commit")
151
152commit_filename="$(mktemp)"
153function clean_up_file() {
154    rm "$commit_filename"
155}
156trap clean_up_file EXIT
157
158function find_codespell_dict_file() {
159    local python_codespell_dict
160    # @formatter:off
161    python_codespell_dict=$(python3 -c "
162import os.path as op
163import codespell_lib
164codespell_dir = op.dirname(codespell_lib.__file__)
165codespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
166print(codespell_file if op.isfile(codespell_file) else '', end='')
167" 2> /dev/null)
168    # @formatter:on
169
170    # Return the path if found, otherwise return an empty string
171    echo "$python_codespell_dict"
172}
173
174function do_commit_spelling() {
175    # Write the commit message to a temporary file
176    git log --format='%B' -1 > "$commit_filename"
177
178    # Some names or emails appear as false-positive misspellings, remove them
179    sed -i "s/Signed-off-by.*//" "$commit_filename"
180
181    # Get the path to the dictionary.txt file
182    local codespell_dict
183    codespell_dict=$(find_codespell_dict_file)
184
185    # Check if the dictionary file was found
186    if [[ -z "$codespell_dict" ]]; then
187        echo "Error: Could not find dictionary.txt file"
188        exit 1
189    fi
190
191    # Run the codespell with codespell dictionary on the patchset
192    echo -n "codespell-dictionary - misspelling count >> "
193    codespell -D "$codespell_dict" -d --count "$commit_filename"
194
195    # Run the codespell with builtin dictionary on the patchset
196    echo -n "generic-dictionary - misspelling count >> "
197    codespell --builtin clear,rare,en-GB_to_en-US -d --count "$commit_filename"
198}
199
200LINTER_REQUIRE+=([commit_gitlint]="gitlint")
201LINTER_TYPES+=([commit_gitlint]="commit")
202function do_commit_gitlint() {
203    gitlint --extra-path "${CONFIG_PATH}/gitlint/" \
204        --config "${CONFIG_PATH}/.gitlint"
205}
206
207# We need different function style for bash/zsh vs plain sh, so beautysh is
208# split into two linters.  "function foo()" is not traditionally accepted
209# POSIX-shell syntax, so shellcheck barfs on it.
210LINTER_REQUIRE+=([beautysh]="beautysh")
211LINTER_IGNORE+=([beautysh]=".beautysh-ignore")
212LINTER_TYPES+=([beautysh]="bash;zsh")
213function do_beautysh() {
214    beautysh --force-function-style fnpar "$@"
215}
216LINTER_REQUIRE+=([beautysh_sh]="beautysh")
217LINTER_IGNORE+=([beautysh_sh]=".beautysh-ignore")
218LINTER_TYPES+=([beautysh_sh]="sh")
219function do_beautysh_sh() {
220    beautysh --force-function-style paronly "$@"
221}
222
223LINTER_REQUIRE+=([black]="black")
224LINTER_TYPES+=([black]="python")
225function do_black() {
226    black -l 79 "$@"
227}
228
229LINTER_REQUIRE+=([eslint]="eslint;.eslintrc.json;${CONFIG_PATH}/eslint-global-config.json")
230LINTER_IGNORE+=([eslint]=".eslintignore")
231LINTER_TYPES+=([eslint]="json")
232function do_eslint() {
233    eslint --no-eslintrc -c "${LINTER_CONFIG[eslint]}" \
234        --ext .json --format=stylish \
235        --resolve-plugins-relative-to /usr/local/lib/node_modules \
236        --no-error-on-unmatched-pattern "$@"
237}
238
239LINTER_REQUIRE+=([flake8]="flake8")
240LINTER_IGNORE+=([flake8]=".flake8-ignore")
241LINTER_TYPES+=([flake8]="python")
242function do_flake8() {
243    flake8 --show-source --extend-ignore=E203,E501 "$@"
244    # We disable E203 and E501 because 'black' is handling these and they
245    # disagree on best practices.
246}
247
248LINTER_REQUIRE+=([isort]="isort")
249LINTER_TYPES+=([isort]="python")
250function do_isort() {
251    isort --profile black "$@"
252}
253
254LINTER_REQUIRE+=([markdownlint]="markdownlint;.markdownlint.yaml;${CONFIG_PATH}/markdownlint.yaml")
255LINTER_IGNORE+=([markdownlint]=".markdownlint-ignore")
256LINTER_TYPES+=([markdownlint]="markdown")
257function do_markdownlint() {
258    markdownlint --config "${LINTER_CONFIG[markdownlint]}" -- "$@"
259}
260
261LINTER_REQUIRE+=([meson]="meson;meson.build")
262LINTER_TYPES+=([meson]="meson")
263function do_meson() {
264    meson format -i "$@"
265}
266
267LINTER_REQUIRE+=([prettier]="prettier;.prettierrc.yaml;${CONFIG_PATH}/prettierrc.yaml")
268LINTER_IGNORE+=([prettier]=".prettierignore")
269LINTER_TYPES+=([prettier]="json;markdown;yaml")
270function do_prettier() {
271    prettier --config "${LINTER_CONFIG[prettier]}" --write "$@"
272}
273
274LINTER_REQUIRE+=([shellcheck]="shellcheck")
275LINTER_IGNORE+=([shellcheck]=".shellcheck-ignore")
276LINTER_TYPES+=([shellcheck]="bash;sh")
277function do_shellcheck() {
278    shellcheck --color=never -x "$@"
279}
280
281LINTER_REQUIRE+=([clang_format]="clang-format;.clang-format")
282LINTER_IGNORE+=([clang_format]=".clang-ignore;.clang-format-ignore")
283LINTER_TYPES+=([clang_format]="c;cpp")
284function do_clang_format() {
285    "${CLANG_FORMAT}" -i "$@"
286}
287
288LINTER_REQUIRE+=([clang_tidy]="true")
289LINTER_TYPES+=([clang_tidy]="clang-tidy-config")
290function do_clang_tidy() {
291    "${TOOLS_PATH}/config-clang-tidy" format
292}
293
294function get_file_type()
295{
296    case "$(basename "$1")" in
297            # First to early detect template files.
298        *.in | *.meson) echo "meson-template" && return ;;
299        *.mako | *.mako.*) echo "mako" && return ;;
300
301        *.ac) echo "autoconf" && return ;;
302        *.[ch]) echo "c" && return ;;
303        *.[ch]pp) echo "cpp" &&  return ;;
304        *.json) echo "json" && return ;;
305        *.md) echo "markdown" && return ;;
306        *.py) echo "python" && return ;;
307        *.tcl) echo "tcl" && return ;;
308        *.yaml | *.yml) echo "yaml" && return ;;
309
310            # Special files.
311        .git/COMMIT_EDITMSG) echo "commit" && return ;;
312        .clang-format) echo "clang-format-config" && return ;;
313        .clang-tidy) echo "clang-tidy-config" && return ;;
314        meson.build) echo "meson" && return ;;
315        meson.options) echo "meson" && return ;;
316    esac
317
318    case "$(file "$1")" in
319        *Bourne-Again\ shell*) echo "bash" && return ;;
320        *C++\ source*) echo "cpp" && return ;;
321        *C\ source*) echo "c" && return ;;
322        *JSON\ data*) echo "json" && return ;;
323        *POSIX\ shell*) echo "sh" && return ;;
324        *Python\ script*) echo "python" && return ;;
325        *python3\ script*) echo "python" && return ;;
326        *zsh\ shell*) echo "zsh" && return ;;
327    esac
328
329    echo "unknown"
330}
331
332LINTERS_AVAILABLE=()
333function check_linter()
334{
335    TITLE="$1"
336    IFS=";" read -r -a ARGS <<< "$2"
337
338    if [[ "${LINTERS_DISABLED[*]}" =~ $1 ]]; then
339        return
340    fi
341
342    if [ 0 -ne "${#LINTERS_ENABLED[@]}" ]; then
343        if ! [[ "${LINTERS_ENABLED[*]}" =~ $1 ]]; then
344            return
345        fi
346    fi
347
348    EXE="${ARGS[0]}"
349    if [ ! -x "${EXE}" ]; then
350        if ! which "${EXE}" > /dev/null 2>&1 ; then
351            echo -e "    ${YELLOW}${TITLE}:${NORMAL} cannot find ${EXE}"
352            if [ -z "$ALLOW_MISSING" ]; then
353                exit 1
354            fi
355            return
356        fi
357    fi
358
359    CONFIG="${ARGS[1]}"
360    FALLBACK="${ARGS[2]}"
361
362    if [ -n "${CONFIG}" ]; then
363        if [ -e "${CONFIG}" ]; then
364            LINTER_CONFIG+=( [${TITLE}]="${CONFIG}" )
365        elif [ -n "${FALLBACK}" ] && [ -e "${FALLBACK}" ]; then
366            echo -e "    ${YELLOW}${TITLE}:${NORMAL} cannot find ${CONFIG}; using ${FALLBACK}"
367            LINTER_CONFIG+=( [${TITLE}]="${FALLBACK}" )
368        else
369            echo -e "    ${YELLOW}${TITLE}:${NORMAL} cannot find config ${CONFIG}"
370            return
371        fi
372    fi
373
374    LINTERS_AVAILABLE+=( "${TITLE}" )
375}
376
377# Check for a global .linter-ignore file.
378GLOBAL_IGNORE=("cat")
379if [ -e ".linter-ignore" ]; then
380    GLOBAL_IGNORE=("${CONFIG_PATH}/lib/ignore-filter" ".linter-ignore")
381fi
382
383# Find all the files in the git repository and organize by type.
384declare -A FILES=()
385FILES+=([commit]=".git")
386
387while read -r file; do
388    ftype="$(get_file_type "$file")"
389    FILES+=([$ftype]="$(echo -ne "$file;${FILES[$ftype]:-}")")
390done < <(git ls-files | xargs realpath --relative-base=. | "${GLOBAL_IGNORE[@]}")
391
392# For each linter, check if there are an applicable files and if it can
393# be enabled.
394for op in "${LINTERS_ALL[@]}"; do
395    for ftype in ${LINTER_TYPES[$op]//;/ }; do
396        if [[ -v FILES["$ftype"] ]]; then
397            check_linter "$op" "${LINTER_REQUIRE[${op}]}"
398            break
399        fi
400    done
401done
402
403# Call each linter.
404for op in "${LINTERS_AVAILABLE[@]}"; do
405
406    # Determine the linter-specific ignore file(s).
407    LOCAL_IGNORE=("${CONFIG_PATH}/lib/ignore-filter")
408    if [[ -v LINTER_IGNORE["$op"] ]]; then
409        for ignorefile in ${LINTER_IGNORE["$op"]//;/ } ; do
410            if [ -e "$ignorefile" ]; then
411                LOCAL_IGNORE+=("$ignorefile")
412            fi
413        done
414    fi
415    if [ 1 -eq ${#LOCAL_IGNORE[@]} ]; then
416        LOCAL_IGNORE=("cat")
417    fi
418
419    # Find all the files for this linter, filtering out the ignores.
420    LINTER_FILES=()
421    while read -r file ; do
422        if [ -e "$file" ]; then
423            LINTER_FILES+=("$file")
424        fi
425        done < <(for ftype in ${LINTER_TYPES[$op]//;/ }; do
426            # shellcheck disable=SC2001
427            echo "${FILES["$ftype"]:-}" | sed "s/;/\\n/g"
428    done | "${LOCAL_IGNORE[@]}")
429
430    # Call the linter now with all the files.
431    if [ 0 -ne ${#LINTER_FILES[@]} ]; then
432        echo -e "    ${BLUE}Running $op${NORMAL}"
433        if ! "do_$op" "${LINTER_FILES[@]}" ; then
434            LINTERS_FAILED+=([$op]=1)
435            echo -e "    ${RED}$op - FAILED${NORMAL}"
436        fi
437    else
438        echo -e "    ${YELLOW}${op}:${NORMAL} all applicable files are on ignore-lists"
439    fi
440done
441
442# Check for failing linters.
443if [ 0 -ne ${#LINTERS_FAILED[@]} ]; then
444    for op in "${!LINTERS_FAILED[@]}"; do
445        echo -e "$op: ${RED}FAILED${NORMAL} (see prior failure)"
446    done
447    exit 1
448fi
449
450# Check for differences.
451if [ -z "$OPTION_NO_DIFF" ]; then
452    echo -e "    ${BLUE}Result differences...${NORMAL}"
453    if ! git --no-pager diff --exit-code ; then
454        echo -e "Format: ${RED}FAILED${NORMAL}"
455        exit 1
456    else
457        echo -e "Format: ${GREEN}PASSED${NORMAL}"
458    fi
459fi
460
461# Sometimes your situation is terrible enough that you need the flexibility.
462# For example, phosphor-mboxd.
463for formatter in "format-code.sh" "format-code"; do
464    if [[ -x "${formatter}" ]]; then
465        echo -e "    ${BLUE}Calling secondary formatter:${NORMAL} ${formatter}"
466        "./${formatter}"
467        if [ -z "$OPTION_NO_DIFF" ]; then
468            git --no-pager diff --exit-code
469        fi
470    fi
471done
472