Merge branch 'main' into fix-test-doubles

Author: antonio-gg-dev

.editorconfig

@@ -5,34 +5,25 @@ end_of_line = lf
 insert_final_newline = true
 charset = utf-8
 trim_trailing_whitespace = true
-
-[**.sh]
 indent_style = space
 indent_size = 2
+
+[**.sh]
 max_line_length = 120
 
 [**.md]
-indent_style = space
 indent_size = 4
 
 [**.ts]
-indent_style = space
-indent_size = 2
 max_line_length = 120
 
 [**.css]
-indent_style = space
-indent_size = 2
 max_line_length = 120
 
-[**.json]
-indent_style = space
-indent_size = 2
-
 [docs/**.md] # YAML support
 indent_size = 2
 
-[{Makefile,**.mk}]
+[{Makefile,**.mk,.git*}]
 indent_style = tab
 
 [{tests/acceptance/**.sh,src/console_header.sh}]

.github/CONTRIBUTING.md

@@ -36,13 +36,12 @@ Please make sure you have [set up your username and email address](https://git-s
 ## Specific set up for documentation application
 
 Our documentation is build with [VitePress](https://vitepress.dev/), for set up a local environment to contribute follow these steps:
-1. You'll need `node` (_we recommend using [nvm](https://github.com/nvm-sh/nvm)_) and `yarn` for set up the environment.
+1. You'll need `node` (_we recommend using [nvm](https://github.com/nvm-sh/nvm)_) and `npm` for set up the environment.
     * Using `nvm` you can execute `nvm use`(reads _.nvmrc_ file) in the project root directory and follow the instructions to use the correct `node` version.
-    * To use `yarn` you need to execute `corepack enable` to activate [Corepack](https://nodejs.org/api/corepack.html).
-2. Install dependencies with `yarn install`.
-3. Run local development server with `yarn docs:dev`.
+2. Install dependencies with `npm ci`.
+3. Run local development server with `npm run docs:dev`.
 4. Implement your changes.
-5. Before submitting your Pull Request run `docs:build` to ensure everything works.
+5. Before submitting your Pull Request run `npm run docs:build` to ensure everything works.
 
 ## Change the configuration
 To change the configuration for the project we use the `.env` file if you would like to know what variables should be there use the following command:

.github/workflows/check-docs.yml

@@ -26,12 +26,12 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 20
-          cache: yarn
+          cache: npm
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Install dependencies
-        run: yarn install --immutable
+        run: npm ci
       - name: Build with VitePress
         run: |
-          yarn docs:build
+          npm run docs:build
           touch docs/.vitepress/dist/.nojekyll

.github/workflows/deploy-docs.yml

@@ -27,14 +27,14 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 20
-          cache: yarn
+          cache: npm
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Install dependencies
-        run: yarn install --immutable
+        run: npm ci
       - name: Build with VitePress
         run: |
-          yarn docs:build
+          npm run docs:build
           touch docs/.vitepress/dist/.nojekyll
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2

.gitignore

@@ -4,16 +4,8 @@
 
 # docs
 node_modules
-yarn-error.log
 docs/.vitepress/cache
 docs/.vitepress/dist
-.yarn/*
-!.yarn/cache
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
 
 # installation
 bin/bashunit

.yarn/releases/yarn-4.0.1.cjs

@@ -1,10 +1,14 @@
 # Changelog
 
-## [Unreleased](https://github.com/TypedDevs/bashunit/compare/0.10.1...main)
+## [Unreleased](https://github.com/TypedDevs/bashunit/compare/0.11.0...main)
+
+## [0.11.0](https://github.com/TypedDevs/bashunit/compare/0.10.1...0.11.0) - 2024-03-02
 
 - Add `--upgrade` option to `./bashunit`
 - Remove support to deprecated `setUp`, `tearDown`, `setUpBeforeScript` and `tearDownAfterScript` functions
 - Optimize test execution time
+- Test functions are now run in the order they're defined in a test file
+- Increase contrast of test results
 
 ## [0.10.1](https://github.com/TypedDevs/bashunit/compare/0.10.0...0.10.1) - 2023-11-13
 

.yarnrc.yml

@@ -1,9 +1,6 @@
 MIT License
 
-Copyright (c) 2023  Jose Maria Valera Reales <chema@typeddevs.com>
-                    Emmanuel Valverde Ramos <manu@typeddevs.com>
-                    Antonio Gonzalez Gea <antonio@typeddevs.com>
-                    Fabrizio Fasanando Sotelo <fabrizio@typeddevs.com>
+Copyright (c) 2023  TypedDevs <team@typeddevs.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

CHANGELOG.md

@@ -4,6 +4,7 @@ SHELL=/bin/bash
 
 STATIC_ANALYSIS_CHECKER := $(shell which shellcheck 2> /dev/null)
 LINTER_CHECKER := $(shell which ec 2> /dev/null)
+GIT_DIR = $(shell git rev-parse --git-dir 2> /dev/null)
 
 OS:=
 ifeq ($(OS),Windows_NT)
@@ -36,16 +37,15 @@ endif
 
 help:
 	@echo ""
-	@echo "usage: make COMMAND"
+	@echo "Usage: make [command]"
 	@echo ""
 	@echo "Commands:"
-	@echo "  test                     Run the test"
-	@echo "  test/list                List all the test under the tests directory"
-	@echo "  test/watch               Automatically run the test every second"
-	@echo "  test/example             Run test from the example directory"
-	@echo "  env/example              Makes a copy of the keys on your .env file"
-	@echo "  pre_commit/install       Installs the pre-commit hook"
-	@echo "  pre_commit/run           Function that will be called when the pre-commit runs"
+	@echo "  test                     Run the tests"
+	@echo "  test/list                List all tests under the tests directory"
+	@echo "  test/watch               Automatically run tests every second"
+	@echo "  env/example              Copy variables without the values from .env into .env.example"
+	@echo "  pre_commit/install       Install the pre-commit hook"
+	@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"
 
@@ -68,32 +68,25 @@ test/watch: $(TEST_SCRIPTS)
 	@fswatch -m poll_monitor -or $(SRC_SCRIPTS_DIR) $(TEST_SCRIPTS_DIR) .env Makefile | xargs -n1 ./bashunit $(TEST_SCRIPTS)
 
 env/example:
-	@echo "Copy the .env into the .env.example file without the values"
+	@echo "Copying variables without the values from .env into .env.example"
 	@sed 's/=.*/=/' .env > .env.example
 
 pre_commit/install:
-	@echo "Installing pre-commit hooks"
-	cp $(PRE_COMMIT_SCRIPTS_FILE) ./.git/hooks/
+	@echo "Installing pre-commit hook"
+	cp $(PRE_COMMIT_SCRIPTS_FILE) $(GIT_DIR)/hooks/
 
 pre_commit/run: test sa lint env/example
 
 sa:
 ifndef STATIC_ANALYSIS_CHECKER
-	@printf "\e[1m\e[31m%s\e[0m\n" "Shellcheck not installed: Static analisys not preformed!" && exit 1
+	@printf "\e[1m\e[31m%s\e[0m\n" "Shellcheck not installed: Static analysis not performed!" && exit 1
 else
 	@shellcheck ./**/*.sh -C && printf "\e[1m\e[32m%s\e[0m\n" "ShellCheck: OK!"
 endif
 
 lint:
 ifndef LINTER_CHECKER
-	@printf "\e[1m\e[31m%s\e[0m\n" "Editorconfig not installed: Lint not preformed!" && exit 1
+	@printf "\e[1m\e[31m%s\e[0m\n" "Editorconfig not installed: Lint not performed!" && exit 1
 else
 	@ec -config .editorconfig && printf "\e[1m\e[32m%s\e[0m\n" "editorconfig-check: OK!"
 endif
-
-test/example:
-	@./bashunit $(EXAMPLE_TEST_SCRIPTS)
-
-test/watch/example:
-	@./bashunit $(EXAMPLE_TEST_SCRIPTS)
-	@fswatch -m poll_monitor -or $(EXAMPLE_TEST_SCRIPTS) | xargs -n1 ./bashunit $(EXAMPLE_TEST_SCRIPTS)