system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-22 18:46:18 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
serenity/Meta/lint-ci.sh

81 lines
2.2 KiB
Bash
Raw Normal View History

Meta: Get building on NixOS (#5005)
2021-01-22 16:44:05 +00:00
#!/usr/bin/env bash
Meta: Add script that runs all lints
2020-11-03 19:11:48 +00:00
set -e
script_path=$(cd -P -- "$(dirname -- "$0")" && pwd -P)
cd "${script_path}/.." || exit 1
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script.
2021-04-30 11:30:04 +00:00
ports=true
if [ "$1" == "--no-ports" ]; then
ports=false
shift
fi
Meta: Run all lint checks and report failures together Problem: - The first lint check that fails results in all subsequent checks not being run. Solution: - Run all the lint checks aggregating the number of failures. - Return a non-0 exit code if any have failed.
2020-12-24 17:13:24 +00:00
RED='\033[0;31m'
GREEN='\033[0;32m'
NC='\033[0m' # No Color
FAILURES=0
set +e
Meta: Add script that runs all lints
2020-11-03 19:11:48 +00:00
for cmd in \
Meta: Verify all AK test files are listed in CMake Problem: - It is possible for a new test file to be added to the `AK/Tests` directory without being added to the corresponding `CMakeLists.txt`. This results in the tests not being run. Solution: - As part of CI linting, verify that all the `AK/Tests/Test*.cpp` files are mentioned in the `CMakeLists.txt`.
2020-12-24 16:39:37 +00:00
Meta/check-ak-test-files.sh \
Meta: Always check completeness of ALL_THE_DEBUG_MACROS
2020-11-28 17:16:38 +00:00
Meta/check-debug-flags.sh \
Meta: Rewrite pre-commit script check-emoji in python This reduces the scripts execution time from 0.57 seconds to 0.01 seconds, while also making the check a bit tighter, leaving fewer possible problems.
2022-09-18 17:20:25 +00:00
Meta/check-emoji.py \
Meta: Invoke markdown-checker if available while linting
2021-10-04 18:56:33 +00:00
Meta/check-markdown.sh \
Meta: Rewrite the check-newlines-at-eof script in python The bash version takes around 15 seconds to run; that is way too slow. This python3 version should take less than one second to run. :^) Also, the script will now also check .py files and .txt CMake files.
2021-01-03 18:31:44 +00:00
Meta/check-newlines-at-eof.py \
Meta: Add a PNG size check to CI and pre-commit checks This uses optipng to check how much size can be reduced on PNG files. If that's more than 2 KiB for at least one file, the check fails. As with other checks, it doesn't run if optipng is not installed.
2022-06-18 11:17:52 +00:00
Meta/check-png-sizes.sh \
Meta: Reimplement license checker in python On my machine, this script took about 3.4 seconds, and was responsible for essentially all of the time taken by the precommit hook. The script is a faithful 1:1 reimplementation, even the regexes are identical. And yet, it takes about 0.02 seconds, making the pre-commit hook lightning fast again. Apparently python is just faster in this case. Fun fact: - Just reading all ~4000 files took bash about 1.2 seconds - Checking the license took another 1.8 seconds in total - Checking for math.h took another 0.4 seconds in total - Checking for '#pragma once' took another 0.4 seconds in total The timing is highly load-dependent, so they don't exactly add up to 3.4 seconds. However, it's good enough to determine that bash is no longer fit for the purpose of this script.
2021-10-26 21:49:28 +00:00
Meta/check-style.py \
Meta: Add script that runs all lints
2020-11-03 19:11:48 +00:00
Meta/lint-executable-resources.sh \
Meta+Userland: Run the GML formatter on CI and pre-commit Now that the GML formatter is both perserving comments and also mostly agrees to the existing GML style, it can be used to auto-format all the GML files in the system. This commit does not only contain the scripts for running the formatting on CI and the pre-commit hook, but also initially formats all the existing GML files so that the hook is successfull.
2022-02-05 13:31:48 +00:00
Meta/lint-gml-format.sh \
Meta: Add gn linter This just calls ``gn format`` on any .gn or .gni files, but it matches the pattern of the other linters.
2023-07-09 23:13:07 +00:00
Meta/lint-gn.sh \
Meta: Remove unused and outdated lint-missing-resources.sh lint This was apparently never used by anyone except me, and currently fails silently. The script originally allowed easy inspection of potentially missing resources, but that seems no longer useful. Even after restoring the script to a working state, I found nothing with it. A somewhat usable version might be available at https://github.com/BenWiederhake/serenity/tree/historic/lint-missing-resources.sh However, there seems to be no interest in the script, so it is better to remove it.
2022-09-12 21:11:54 +00:00
Meta/lint-keymaps.py \
Meta: Add flake8 to lint python files
2021-01-04 02:08:26 +00:00
Meta/lint-prettier.sh \
Meta: Remove unused and outdated lint-missing-resources.sh lint This was apparently never used by anyone except me, and currently fails silently. The script originally allowed easy inspection of potentially missing resources, but that seems no longer useful. Even after restoring the script to a working state, I found nothing with it. A somewhat usable version might be available at https://github.com/BenWiederhake/serenity/tree/historic/lint-missing-resources.sh However, there seems to be no interest in the script, so it is better to remove it.
2022-09-12 21:11:54 +00:00
Meta/lint-python.sh \
Meta/lint-shell-scripts.sh; do
Meta+Utilities: Make pre-commit checks significantly less verbose When markdown-check is built, it outputs hundreds of lines of "ignoring this and that link because reasons". This is extremely not helpful when trying to figure out exactly which check failed on your commit. Also remove the timing numbers from lint-ci.sh These are just noise and also don't help to figure out which pre-commit check failed. Ideally the output on fail should be "[OK]: Check A" for all the passing checks and "[FAIL] Check N" with the required context for the failed check.
2023-07-25 17:52:06 +00:00
if "${cmd}" "$@"; then
Meta: Update lint-{clang-format,shell-scripts}.sh to take a list of files This should speed up pre-commit a bit as only files that are staged will be processed, and clang-format and shellcheck are only invoked once, not for every file. When no arguments are given (e.g. on CI), it still uses 'git ls-files'.
2020-12-27 14:34:06 +00:00
echo -e "[${GREEN}OK${NC}]: ${cmd}"
Meta: Run all lint checks and report failures together Problem: - The first lint check that fails results in all subsequent checks not being run. Solution: - Run all the lint checks aggregating the number of failures. - Return a non-0 exit code if any have failed.
2020-12-24 17:13:24 +00:00
else
Meta: Update lint-{clang-format,shell-scripts}.sh to take a list of files This should speed up pre-commit a bit as only files that are staged will be processed, and clang-format and shellcheck are only invoked once, not for every file. When no arguments are given (e.g. on CI), it still uses 'git ls-files'.
2020-12-27 14:34:06 +00:00
echo -e "[${RED}FAIL${NC}]: ${cmd}"
((FAILURES+=1))
Meta: Run all lint checks and report failures together Problem: - The first lint check that fails results in all subsequent checks not being run. Solution: - Run all the lint checks aggregating the number of failures. - Return a non-0 exit code if any have failed.
2020-12-24 17:13:24 +00:00
fi
Meta: Add script that runs all lints
2020-11-03 19:11:48 +00:00
done
Meta+Lagom: Enable CMAKE_BUILD_WITH_INSTALL_RPATH On macOS, CMake incorrectly tries to add and/or remove rpaths from files that it has already processed when it performs installation. Setting the rpaths during the build process ensures that they are only set once, and as a bonus, makes installation slightly more performant. Fixes #10055.
2023-03-18 15:23:35 +00:00
if [ -x ./Build/lagom/bin/IPCMagicLinter ]; then
Meta+Utilities: Make pre-commit checks significantly less verbose When markdown-check is built, it outputs hundreds of lines of "ignoring this and that link because reasons". This is extremely not helpful when trying to figure out exactly which check failed on your commit. Also remove the timing numbers from lint-ci.sh These are just noise and also don't help to figure out which pre-commit check failed. Ideally the output on fail should be "[OK]: Check A" for all the passing checks and "[FAIL] Check N" with the required context for the failed check.
2023-07-25 17:52:06 +00:00
if { git ls-files '*.ipc' | xargs ./Build/lagom/bin/IPCMagicLinter; }; then
Meta: Run IPC magic number linter during CI and pre-commit
2021-11-01 16:20:54 +00:00
echo -e "[${GREEN}OK${NC}]: IPCMagicLinter (in Meta/lint-ci.sh)"
else
echo -e "[${RED}FAIL${NC}]: IPCMagicLinter (in Meta/lint-ci.sh)"
((FAILURES+=1))
fi
else
echo -e "[${GREEN}SKIP${NC}]: IPCMagicLinter (in Meta/lint-ci.sh)"
fi
Meta+Utilities: Make pre-commit checks significantly less verbose When markdown-check is built, it outputs hundreds of lines of "ignoring this and that link because reasons". This is extremely not helpful when trying to figure out exactly which check failed on your commit. Also remove the timing numbers from lint-ci.sh These are just noise and also don't help to figure out which pre-commit check failed. Ideally the output on fail should be "[OK]: Check A" for all the passing checks and "[FAIL] Check N" with the required context for the failed check.
2023-07-25 17:52:06 +00:00
if Meta/lint-clang-format.sh --overwrite-inplace "$@" && git diff --exit-code; then
Meta: Run all lint checks and report failures together Problem: - The first lint check that fails results in all subsequent checks not being run. Solution: - Run all the lint checks aggregating the number of failures. - Return a non-0 exit code if any have failed.
2020-12-24 17:13:24 +00:00
echo -e "[${GREEN}OK${NC}]: Meta/lint-clang-format.sh"
else
echo -e "[${RED}FAIL${NC}]: Meta/lint-clang-format.sh"
((FAILURES+=1))
fi
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script.
2021-04-30 11:30:04 +00:00
# lint-ports.py is handled separately as it scans all Ports/ all the time.
# This is fine when running lint-ci.sh from the PR validation workflow.
# However when running from the pre-commit workflow it takes an excessive
# amount of time. This condition allows the pre-commit program to detect
# when Ports/ files have changed and only invoke lint-ports.py when needed.
#
if [ "$ports" = true ]; then
Meta+Utilities: Make pre-commit checks significantly less verbose When markdown-check is built, it outputs hundreds of lines of "ignoring this and that link because reasons". This is extremely not helpful when trying to figure out exactly which check failed on your commit. Also remove the timing numbers from lint-ci.sh These are just noise and also don't help to figure out which pre-commit check failed. Ideally the output on fail should be "[OK]: Check A" for all the passing checks and "[FAIL] Check N" with the required context for the failed check.
2023-07-25 17:52:06 +00:00
if Meta/lint-ports.py; then
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script.
2021-04-30 11:30:04 +00:00
echo -e "[${GREEN}OK${NC}]: Meta/lint-ports.py"
else
echo -e "[${RED}FAIL${NC}]: Meta/lint-ports.py"
((FAILURES+=1))
fi
fi
Meta: Add script that runs all lints
2020-11-03 19:11:48 +00:00
echo "(Also look out for check-symbols.sh, which can only be executed after the build!)"
Meta: Run all lint checks and report failures together Problem: - The first lint check that fails results in all subsequent checks not being run. Solution: - Run all the lint checks aggregating the number of failures. - Return a non-0 exit code if any have failed.
2020-12-24 17:13:24 +00:00
Meta: Make lint-shell-scripts.sh happy `${FAILURES}` -> `"${FAILURES}"`
2020-12-26 08:26:32 +00:00
exit "${FAILURES}"
Reference in a new issue Copy permalink