newtypedecl 0.0.1

declarative newtype macro
Documentation 
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
59

# -*- mode: sh; sh-shell: bash -*-
# vim: set ft=bash:
# shellcheck shell=bash

### Support for the shellcheck shell linter
###
### Shellcheck is surprisingly slow.  In projects using bar one can prevent the bar files
### themselves being checked by setting in 'Barf':
###
###  SHELLCHECK_LS_FILES=":!bar :!Bar.d"  # Perhaps adding ':!Barf' too

require git_lib

declare -gx SHELLCHECK_LS_FILES="${SHELLCHECK_LS_FILES:-}" ## List of file match rules for git-ls-files.

function shellcheck_is_shscript ## <file> - Check if <file> is a shell script
{
    [[ -f "$1" ]] && head -5 "$1" | grep -Eq '^#!.*sh|^# shellcheck'
}

function shellcheck_has_shscripts
{
    local file
    for file in $(git_ls_files -c --other ${SHELLCHECK_LS_FILES:+-- $SHELLCHECK_LS_FILES}); do
        if shellcheck_is_shscript "$file"; then
            trace "Shell scripts found"
            return 0
        fi
    done
    debug "No shell scripts found in the repository"
    return 1
}
memofn shellcheck_has_shscripts

## Checks if the project has any shell scripts. Must be called from a git toplevel.
## Checks whenever any shell scripts are versioned in gitq
rule shellcheck_has_shscripts: is_git_toplevel -

function shellcheck_list_shscripts ## List all shell scripts under git control
{
    local file
    for file in $(git_ls_files -c --other ${SHELLCHECK_LS_FILES:+-- $SHELLCHECK_LS_FILES}); do
        if shellcheck_is_shscript "$file"; then
            echo "$file"
        fi
    done
}
memofn shellcheck_list_shscripts

function shellcheck_lint ## Test if all shell scripts under git control pass the linter.
{
    trace "shellcheck --color $(shellcheck_list_shscripts)"
    # shellcheck disable=SC2046
    shellcheck --color $(shellcheck_list_shscripts)
}

# Define --bare rules for shellcheck query/predicate functions
rule --bare shellcheck_is_shscript: -
rule --bare shellcheck_list_shscripts: -