From 3479af9016753f09797543bbbcb8c423300fb91a Mon Sep 17 00:00:00 2001 From: Ahmad Nassri Date: Sun, 3 Sep 2023 10:14:46 -0400 Subject: [PATCH] refactor: rename semantic-release config file --- .github/{test-matrix.json => matrix-test.json} | 0 .github/template-sync.yml | 2 +- .npmignore | 2 +- .semantic.json => .release.json | 0 Makefile | 16 ++++++++-------- docker-compose.yml | 6 ++++-- package.json | 4 ++-- test/index.js | 6 +++--- 8 files changed, 19 insertions(+), 17 deletions(-) rename .github/{test-matrix.json => matrix-test.json} (100%) rename .semantic.json => .release.json (100%) diff --git a/.github/test-matrix.json b/.github/matrix-test.json similarity index 100% rename from .github/test-matrix.json rename to .github/matrix-test.json diff --git a/.github/template-sync.yml b/.github/template-sync.yml index 363c661..34441bc 100644 --- a/.github/template-sync.yml +++ b/.github/template-sync.yml @@ -11,7 +11,7 @@ files: - "!docs/README.md" - "!colophon.yml" - "!package*.json" - - "!.github/test-matrix.json" + - "!.github/matrix-*.json" - "!**/template-sync.yml" - "!.github/dependabot.yml" - "!.github/workflows/*.yml" diff --git a/.npmignore b/.npmignore index 6e93463..adc27ff 100644 --- a/.npmignore +++ b/.npmignore @@ -11,7 +11,7 @@ node_modules .editorconfig .github .pandoc.yml -.semantic.json +.release.json colophon.yml docker-compose.yml Makefile diff --git a/.semantic.json b/.release.json similarity index 100% rename from .semantic.json rename to .release.json diff --git a/Makefile b/Makefile index 090c635..1e7783c 100644 --- a/Makefile +++ b/Makefile @@ -11,25 +11,25 @@ NPMRC := $(shell npm config get userconfig) pull: ## pull latest containers @docker compose pull -readme: ## pull latest containers +readme: ## generate root README.md @docker compose run --rm readme lint: ## run super-linter @docker compose run --rm lint install: ## install all dependencies - @docker compose run --rm -e NPM_TOKEN=$(NPM_TOKEN) -e GITHUB_TOKEN=$(GITHUB_TOKEN) -v $(NPMRC):/root/.npmrc app install + @docker compose run --rm app install test: ## run all npm tests - @docker compose --profile test up + @docker compose run --rm app test shell: ## start the container shell @docker compose run --rm --entrypoint /bin/sh app -clean: ## remove running containers, volumes, node_modules & anything else - @docker compose rm --force -v - @docker compose --profile test down - @rm -rf node_modules coverage .nyc_output +clean: ## delete containers, images, volumes, node_modules + @docker compose run --rm --entrypoint "rm -rf node_modules" app + @docker compose rm --stop --force --volumes + @docker compose down --remove-orphans --volumes --rmi local # Utility methods ## Help: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html @@ -38,4 +38,4 @@ help: ## display this help @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) .DEFAULT_GOAL := help -.PHONY: help all clean test coverage +.PHONY: help all clean test diff --git a/docker-compose.yml b/docker-compose.yml index 6673be7..f1a2b46 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -26,13 +26,15 @@ services: profiles: ["app"] image: node:latest working_dir: /usr/src/lib - entrypoint: npm --no-update-notifier --no-fund --no-audit - command: start + entrypoint: npm tty: true volumes: - ./:/usr/src/lib environment: NODE_ENV: test + NPM_CONFIG_UPDATE_NOTIFIER: false + NPM_CONFIG_FUND: false + NPM_CONFIG_AUDIT: false test-command: extends: app diff --git a/package.json b/package.json index 5624bda..0a1fd2e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "version": "0.0.0-semantically-released", - "name": "@ahmadnassri/template-lib", + "name": "@ahmadnassri/template-node-lib", "description": "node library project template", "author": "Ahmad Nassri (https://www.ahmadnassri.com)", "homepage": "https://github.com/ahmadnassri/template-node-lib", @@ -22,7 +22,7 @@ "library" ], "engines": { - "node": ">=14" + "node": ">=18" }, "files": [ "src" diff --git a/test/index.js b/test/index.js index 6732586..9022441 100644 --- a/test/index.js +++ b/test/index.js @@ -1,6 +1,6 @@ -const { test } = require('tap') +const { test } = require('node:test') +const assert = require('node:assert') -test('example', assert => { - assert.plan(1) +test('example', () => { assert.ok(true) })