feat: Migrate to make

oliversalzburg · oliversalzburg · commit 35674448eb9a · 2025-02-26T16:17:11.000+01:00
diff --git a/Makefile b/Makefile
@@ -1,3 +1,28 @@
-.PHONE: pretty
+.PHONY: default build clean docs pretty lint test run
+
+default: clean build
+
+build: output
+
+clean:
+	rm -rf ./output tsconfig.tsbuildinfo
+
+docs:
+	podman run --rm --volume ${PWD}:/docs docker.io/squidfunk/mkdocs-material build --site-dir=public
+
 pretty:
 	yarn biome check --write --no-errors-on-unmatched
+
+lint:
+	yarn biome check .
+	yarn tsc --noEmit
+
+test: clean build
+	node --experimental-vm-modules $(shell yarn bin jest) --coverage source
+
+run: clean build
+	node ./output/main.js
+
+
+output:
+	yarn tsc
diff --git a/docs/reference/Repository Scripts/.postversion.md b/docs/reference/Repository Scripts/.postversion.md
@@ -0,0 +1,12 @@
+## postversion
+
+-   Project: `node-scripts-docs`
+-   Source:
+
+    ```shell
+    git push
+    ```
+
+-   Description:
+
+    _documentation pending_
diff --git a/docs/reference/Repository Scripts/.prepack.md b/docs/reference/Repository Scripts/.prepack.md
@@ -4,7 +4,7 @@
 -   Source:
 
     ```shell
-    yarn build
+    make
     ```
 
 -   Description:
diff --git a/docs/reference/Repository Scripts/.preversion.md b/docs/reference/Repository Scripts/.preversion.md
@@ -0,0 +1,12 @@
+## preversion
+
+-   Project: `node-scripts-docs`
+-   Source:
+
+    ```shell
+    make lint test
+    ```
+
+-   Description:
+
+    _documentation pending_
diff --git a/docs/reference/Repository Scripts/index.md b/docs/reference/Repository Scripts/index.md
@@ -1,157 +1,41 @@
 # Full reference
 
-## build
+## postversion
 
 -   Project: `node-scripts-docs`
 -   Source:
 
     ```shell
-    tsc
-    ```
-
--   Description:
-
-    Build the TypeScript sources.
-
-## docs:build
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    podman run --rm -it -p 8000:8000 -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material build --site-dir=public
-    ```
-
--   Description:
-
-    Build the documentation website locally.
-
-## docs:scripts
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    yarn nsd-debug
-    ```
-
--   Description:
-
-    Rebuilds the `node-scripts-docs` documentation for this project itself.
-
-## docs:serve
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    podman run --rm -it -p 8000:8000 -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material
-    ```
-
--   Description:
-
-    Runs the mkdocs-material development server.
-
-## npm:publish
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    npm publish
-    ```
-
--   Description:
-
-    Build the latest sources and then `npm publish` the current state.
-
-## npm:publish:major
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    npm version major && npm publish
+    git push
     ```
 
 -   Description:
 
     _documentation pending_
 
-## npm:publish:minor
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    npm version minor && npm publish
-    ```
-
--   Description:
-
-    _documentation pending_
-
-## npm:publish:patch
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    npm version patch && npm publish
-    ```
-
--   Description:
-
-    Publish a patch release to the npm registry.
-
-## nsd-debug
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    yarn build && node output/node-scripts-docs.js
-    ```
-
--   Description:
-
-    Build the latest sources and then use the build output to execute your command. Parameters are passed through by `yarn`.
-
 ## prepack
 
 -   Project: `node-scripts-docs`
 -   Source:
 
     ```shell
-    yarn build
+    make
     ```
 
 -   Description:
 
     _documentation pending_
 
-## test
+## preversion
 
 -   Project: `node-scripts-docs`
 -   Source:
 
     ```shell
-    node --experimental-vm-modules $(yarn bin jest)
+    make lint test
     ```
 
 -   Description:
 
-    Execute all Jest test suites.
-
-## test:coverage
-
--   Project: `node-scripts-docs`
--   Source:
-
-    ```shell
-    node --experimental-vm-modules $(yarn bin jest) --coverage
-    ```
-
--   Description:
+    _documentation pending_
 
-    Execute Jest test suites and calculate code coverage.
diff --git a/package.json b/package.json
@@ -15,23 +15,11 @@
   },
   "type": "module",
   "bin": {
-    "nsd": "output/node-scripts-docs.js"
+    "nsd": "output/main.js"
   },
   "scripts": {
-    "build": "tsc",
-    "docs:build": "podman run --rm -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material build --site-dir=public",
-    "docs:scripts": "yarn nsd-debug",
-    "docs:serve": "podman run --rm -it -p 8000:8000 -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material",
-    "lint": "yarn run lint:all",
-    "lint:all": "yarn run lint:biome && yarn run lint:tsc",
-    "lint:biome": "biome check .",
-    "lint:tsc": "tsc --noEmit",
-    "nextversion": "./.scripts/manifest-version.cjs",
-    "nsd-debug": "yarn build && node output/node-scripts-docs.js",
-    "prepack": "yarn build",
-    "test": "node --experimental-vm-modules $(yarn bin jest) source",
-    "test:coverage": "node --experimental-vm-modules $(yarn bin jest) --coverage",
-    "preversion": "yarn run lint && yarn run build && yarn run test",
+    "prepack": "make",
+    "preversion": "make lint test",
     "postversion": "git push"
   },
   "dependencies": {
diff --git a/package.json-scripts.json b/package.json-scripts.json
@@ -4,107 +4,26 @@
     {
       "manifestPath": "package.json",
       "projectName": "node-scripts-docs",
-      "scriptName": "build",
-      "scriptCode": "tsc",
+      "scriptName": "postversion",
+      "scriptCode": "git push",
       "isGlobal": false,
-      "isRootManifest": true,
-      "description": "Build the TypeScript sources."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "docs:build",
-      "scriptCode": "podman run --rm -it -p 8000:8000 -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material build --site-dir=public",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Build the documentation website locally."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "docs:scripts",
-      "scriptCode": "yarn nsd-debug",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Rebuilds the `node-scripts-docs` documentation for this project itself."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "docs:serve",
-      "scriptCode": "podman run --rm -it -p 8000:8000 -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Runs the mkdocs-material development server."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "npm:publish",
-      "scriptCode": "npm publish",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Build the latest sources and then `npm publish` the current state."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "npm:publish:major",
-      "scriptCode": "npm version major && npm publish",
-      "isGlobal": true,
       "isRootManifest": true
     },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "npm:publish:minor",
-      "scriptCode": "npm version minor && npm publish",
-      "isGlobal": true,
-      "isRootManifest": true
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "npm:publish:patch",
-      "scriptCode": "npm version patch && npm publish",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Publish a patch release to the npm registry."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "nsd-debug",
-      "scriptCode": "yarn build && node output/node-scripts-docs.js",
-      "isGlobal": false,
-      "isRootManifest": true,
-      "description": "Build the latest sources and then use the build output to execute your command. Parameters are passed through by `yarn`."
-    },
     {
       "manifestPath": "package.json",
       "projectName": "node-scripts-docs",
       "scriptName": "prepack",
-      "scriptCode": "yarn build",
+      "scriptCode": "make",
       "isGlobal": false,
       "isRootManifest": true
     },
     {
       "manifestPath": "package.json",
       "projectName": "node-scripts-docs",
-      "scriptName": "test",
-      "scriptCode": "node --experimental-vm-modules $(yarn bin jest)",
+      "scriptName": "preversion",
+      "scriptCode": "make lint test",
       "isGlobal": false,
-      "isRootManifest": true,
-      "description": "Execute all Jest test suites."
-    },
-    {
-      "manifestPath": "package.json",
-      "projectName": "node-scripts-docs",
-      "scriptName": "test:coverage",
-      "scriptCode": "node --experimental-vm-modules $(yarn bin jest) --coverage",
-      "isGlobal": true,
-      "isRootManifest": true,
-      "description": "Execute Jest test suites and calculate code coverage."
+      "isRootManifest": true
     }
   ],
   "version": 1
diff --git a/source/main.ts b/source/main.ts
