968a612824
Report issues by shell files with:
git ls-files '*.sh' | xargs shellcheck --exclude=SC2162
Address the following:
- SC1087: Use braces when expanding arrays
- SC1091: Not following
- SC2004: `$`/`${}` is unnecessary on arithmetic variables
- SC2024: `sudo` doesn't affect redirects
- SC2034: foo appears unused. Verify it or export it
- SC2086: Double quote to prevent globbing and word splitting
- SC2087: Quote `EOF`
- SC2115: Use `"${var:?}"` to ensure this never expands to `/*`
- SC2148: Add a shebang
Addresses (at least partially) some POSIX/dash issues:
- SC2113: `function` keyword is non-standard
- SC3010: In POSIX sh, `[[` `]]` is undefined
- SC3014: In POSIX sh, `==` in place of `=` is undefined
- SC3020: In POSIX sh, `&>` is undefined
- SC3046: In POSIX sh, `source` in place of `.` is undefined
Does not address:
- SC2162: `read` without `-r` will mangle backslashes
- Any other POSIX/dash-specific issues
Signed-off-by: Tim Crawford <tcrawford@system76.com>
77 lines
1.6 KiB
Bash
Executable File
77 lines
1.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
README_DIRS=(
|
|
apps
|
|
models
|
|
tools
|
|
)
|
|
|
|
set -e
|
|
|
|
cargo build --manifest-path "scripts/modeltool/Cargo.toml" --release
|
|
|
|
MODELTOOL="$(realpath "scripts/modeltool/target/release/modeltool")"
|
|
|
|
readme_model() {
|
|
echo -e "\x1B[1m$1\x1B[0m" >&2
|
|
|
|
pushd "$1" > /dev/null
|
|
cp README.md.in README.md
|
|
|
|
echo -e "\n## Contents\n" >> README.md
|
|
"$MODELTOOL" . >> README.md
|
|
popd > /dev/null
|
|
}
|
|
|
|
for dir in models/*/
|
|
do
|
|
readme_model "${dir%/}"
|
|
done
|
|
|
|
readme_line() {
|
|
echo -e " \x1B[1m$1\x1B[0m" >&2
|
|
|
|
name="$(basename "$1")"
|
|
description=""
|
|
|
|
readme="$(find "$1" -maxdepth 1 -iname README.md)"
|
|
if [ -n "$readme" ]
|
|
then
|
|
# Get first line, removing the trailing pounds and spaces
|
|
description=" - $(head -n 1 "$readme" | sed -e 's/^[#[:space:]]*//')"
|
|
fi
|
|
|
|
submodule="$(git submodule status "$1" 2> /dev/null | cut -d ' ' -f 3 || true)"
|
|
if [ "$submodule" = "$1" ]
|
|
then
|
|
# Link to submodule URL
|
|
origin="$(git -C "$1" remote get-url origin)"
|
|
echo "- [$name]($origin)$description"
|
|
else
|
|
# Link to directory
|
|
echo "- [$name](./$1)$description"
|
|
fi
|
|
}
|
|
|
|
readme_dir() {
|
|
echo -e "\x1B[1m$1\x1B[0m" >&2
|
|
|
|
pushd "$1" > /dev/null
|
|
cp README.md.in README.md
|
|
|
|
echo -e "\n## Contents\n" >> README.md
|
|
for dir in */
|
|
do
|
|
if ! git check-ignore --quiet "${dir}"
|
|
then
|
|
readme_line "${dir%/}" >> README.md
|
|
fi
|
|
done
|
|
popd > /dev/null
|
|
}
|
|
|
|
for dir in "${README_DIRS[@]}"
|
|
do
|
|
readme_dir "$dir"
|
|
done
|