Add test hook

Signed-off-by: Victor Seiji Hariki <victorseijih@gmail.com>
This commit is contained in:
Victor Seiji Hariki 2022-12-28 21:38:10 -03:00
parent 6b3e471b36
commit dd2dc5deb0
6 changed files with 86 additions and 0 deletions

12
.devtools/README.md Normal file
View file

@ -0,0 +1,12 @@
# openOutpaint DevTools
This is a folder containing some handy scripts to help developers to automate workflows and write code in openOutpaint's standards.
All scripts must be run from the root of the project.
## `sethooks.sh` script
This script will setup git hooks for this project. Hooks are mainly for cache busting purposes for now. It is recommended to run this script and setup hooks before any commits are made.
## `lint.sh` script
Uses `npm` to install prettier and lint javascript, html and css files according to `.prettierrc.json`. This script will install node modules locally, so editors with prettier support are recommended over this script.

0
lint.sh → .devtools/lint.sh Normal file → Executable file
View file

3
.devtools/sethooks.sh Executable file
View file

@ -0,0 +1,3 @@
#!/usr/bin/sh
git config core.hooksPath .githooks

0
.githooks/.gitkeep Normal file
View file

49
.githooks/pre-commit Executable file
View file

@ -0,0 +1,49 @@
#!/bin/sh
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments. The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-commit".
if git rev-parse --verify HEAD >/dev/null 2>&1
then
against=HEAD
else
# Initial commit: diff against an empty tree object
against=$(git hash-object -t tree /dev/null)
fi
# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --type=bool hooks.allownonascii)
# Redirect output to stderr.
exec 1>&2
# Cross platform projects tend to avoid non-ASCII filenames; prevent
# them from being added to the repository. We exploit the fact that the
# printable range starts at the space character and ends with tilde.
if [ "$allownonascii" != "true" ] &&
# Note that the use of brackets around a tr range is ok here, (it's
# even required, for portability to Solaris 10's /usr/bin/tr), since
# the square bracket bytes happen to fall in the designated range.
test $(git diff --cached --name-only --diff-filter=A -z $against |
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
then
cat <<\EOF
Error: Attempt to add a non-ASCII file name.
This can cause problems if you want to work with people on other platforms.
To be portable it is advisable to rename the file.
If you know what you are doing you can disable this check using:
git config hooks.allownonascii true
EOF
exit 1
fi
# If there are whitespace errors, print the offending file names and fail.
exec git diff-index --check --cached $against --

22
.github/workflows/cachebusting.yml vendored Normal file
View file

@ -0,0 +1,22 @@
name: Cache Busting
on:
push:
branches:
- "main"
- "testing"
pull_request:
branches: [main, testing]
types: [opened, synchronize, closed]
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Prettify
uses: creyD/prettier_action@v4.2
with:
prettier_options: --write **/*.{js,html,css,md}