Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ help:
@echo " pre_commit/run Function that will be called when the pre-commit hook runs"
@echo " sa Run shellcheck static analysis tool"
@echo " lint Run editorconfig linter tool"
@echo " deps Install required test dependencies"

SRC_SCRIPTS_DIR=src
PRE_COMMIT_SCRIPTS_FILE=./bin/pre-commit
Expand All @@ -71,3 +72,6 @@ ifndef LINTER_CHECKER
else
@ec -config .editorconfig && printf "\e[1m\e[32m%s\e[0m\n" "editorconfig-check: OK!"
endif

deps:
bash install-dependencies.sh
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,27 @@ Downloading 'create-pr' to 'lib'...
Downloading 'dumper.sh' to 'src/dev'...
> dumper.sh installed successfully in 'src/dev'
```

### Development

Install required dependencies to run the tests:

```bash
make deps
```

Then run the test suite and linters:

```bash
make test
make sa
make lint
```

To enable automatic checks before each commit install the pre-commit hook:

```bash
make pre_commit/install
```

For more details see [CONTRIBUTING](.github/CONTRIBUTING.md).
4 changes: 3 additions & 1 deletion install-dependencies.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#!/bin/bash
set -euo pipefail

curl -s https://bashunit.typeddevs.com/install.sh | bash
echo "Installing test dependencies via bashunit installer..."
curl -fsSL https://bashunit.typeddevs.com/install.sh | bash