create-minimal-package 1.1.1 → 1.2.0

package/README.md

@@ -20,12 +20,12 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
   - [New Issue Templates](https://github.com/34j/create-minimal-package/tree/main/.github/ISSUE_TEMPLATE): from [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/tree/main/.github/ISSUE_TEMPLATE)
   - [💨GitHub Actions](https://github.com/34j/create-minimal-package/tree/main/.github/workflows) + [📊Codecov](https://about.codecov.io/): npm version of [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/blob/main/.github/workflows/ci.yml)
   - [🧱Renovate](https://docs.renovatebot.com/): inherits [config:best-practices](https://docs.renovatebot.com/presets-config/#configbest-practices)
-- [⚙TypeScript](https://www.typescriptlang.org/):`tsconfig.json`,`tsconfig.build.json`(w/o tests): inherits [@tsconfig/strictest](https://www.npmjs.com/package/@tsconfig/strictest): 4 lines for `☆`, [3 lines for ES types](https://youtu.be/H91aqUHn8sE?t=148)
+- [⚙TypeScript](https://www.typescriptlang.org/):`tsconfig.json`: inherits [@tsconfig/strictest](https://www.npmjs.com/package/@tsconfig/strictest): 4 lines for `☆`, [3 lines for ES types](https://youtu.be/H91aqUHn8sE?t=148)
 - ✨️Formatting
-  - [⚠️Pre-commit](https://pre-commit.com/) and [pre-commit.ci](https://pre-commit.ci/): from [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/tree/main/.github/ISSUE_TEMPLATE) + [mirrors-eslint](https://github.com/pre-commit/mirrors-eslint) instead of [🐶Husky](https://github.com/typicode/husky) + [Lint Staged](https://github.com/okonet/lint-staged) for better CI support
+  - [⚠️Pre-commit](https://pre-commit.com/) and [pre-commit.ci](https://pre-commit.ci/): from [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/tree/main/.github/ISSUE_TEMPLATE) + [mirrors-eslint](https://github.com/pre-commit/mirrors-eslint) (⏪️[🐶Husky](https://github.com/typicode/husky) + [Lint Staged](https://github.com/okonet/lint-staged) for better CI support)
   - [ESLint](https://eslint.org/): inherits [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config)
 - ⚠️ Testing
-  - [👢Jest](https://jestjs.io/): 2 lines for supporting Codecov and 2 lines for supporting Node.js `P`
+  - [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)): 0 lines
 - 📖Documentation
   - [🌐GitHub Pages](https://pages.github.com/)
   - [📖TypeDoc](https://typedoc.org/): 2 lines for `☆` `P`
@@ -39,18 +39,17 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
 
 </details>
 
-## Getting started
-
-### Set up your repository
+## Quickstart
 
 1. **Click the "Use this template" button.**
 2. Replace `FULL_NAME`, `GITHUB_USER`, and `REPO_NAME` using `sed`:
   ```bash
-  FULL_NAME="John Smith"
   GITHUB_USER="johnsmith"
   REPO_NAME="my-cool-package"
-  sed -i.mybak "s/\([^@]\)34j/\1$GITHUB_USER/g; s/create-minimal-package\|my-package-name/$REPO_NAME/g; s/Ryan Sonshine/$FULL_NAME/g" package.json package-lock.json src/index.ts
-  rm *.mybak
+  sed -i.tmp "s/\([^@]\)34j/\1$GITHUB_USER/g; s/create-minimal-package\|my-package-name/$REPO_NAME/g; package.json package-lock.json src/index.ts
+  sed -i.tmp 's/"version": "[0-9.]*"/"version": "0.0.0"/' package.json
+  rm *.tmp
+  rm CHANGELOG.md
   ```
 3. Add `NPM_TOKEN` to `Settings/Secrets and variables/Actions/Repository secrets`.
 4. Add `CODECOV_TOKEN` to `Settings/Secrets and variables/Actions/Repository secrets`.

package/dist/test/index.spec.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const src_1 = require("../src");
+(0, vitest_1.describe)('index', () => {
+    (0, vitest_1.describe)('myPackage', () => {
+        (0, vitest_1.it)('should return a string containing the message', () => {
+            const message = 'Hello';
+            const result = (0, src_1.myPackage)(message);
+            (0, vitest_1.expect)(result).toMatch(message);
+        });
+    });
+});

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "create-minimal-package",
   "type": "commonjs",
-  "version": "1.1.1",
-  "description": "Minimalistic npm package template with 📦🚀semantic-release + Commitizen, CodeCov, Renovate, pre-commit + EsLint (✗🐶Husky + Lint Staged), 👢Jest, 📖TypeDoc + Github Pages support. Note that this is a generated sample package.",
+  "version": "1.2.0",
+  "description": "Minimalistic npm package template with 📦🚀semantic-release + Commitizen, CodeCov, Renovate, pre-commit + EsLint (✗🐶Husky + Lint Staged), ⚡️Vitest (✗👢Jest), 📖TypeDoc + Github Pages support. Note that this is a generated sample package.",
   "author": {
     "name": "34j"
   },
@@ -19,9 +19,8 @@
     "boilerplate",
     "template",
     "typescript",
-    "vscode",
-    "jest",
-    "husky",
+    "vitest",
+    "pre-commit",
     "semantic-release",
     "typedoc"
   ],
@@ -33,13 +32,13 @@
     "node": ">=12.0"
   },
   "scripts": {
-    "build:watch": "tsc --watch --project tsconfig.build.json",
-    "build": "tsc --project tsconfig.build.json",
+    "build:watch": "tsc --watch --project tsconfig.json",
+    "build": "tsc --project tsconfig.json",
     "lint": "eslint --fix",
     "typedoc": "typedoc",
     "typedoc:watch": "typedoc --watch",
-    "test:watch": "jest --watch",
-    "test": "jest --coverage",
+    "test:watch": "vitest --watch",
+    "test": "vitest --coverage",
     "watch": "npm-run-all --race --parallel *:watch",
     "update": "npm-check-updates -u"
   },
@@ -48,33 +47,23 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@tsconfig/strictest": "^2.0.5",
-    "@types/jest": "^29.5.14",
     "@types/node": "^22.13.10",
     "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@vitest/coverage-v8": "^3.0.8",
     "eslint": "^9.22.0",
     "globals": "^16.0.0",
-    "jest": "^29.7.0",
     "npm-check-updates": "^17.1.15",
     "npm-run-all2": "5.0.0",
     "semantic-release": "^24.2.3",
-    "ts-jest": "^29.2.6",
     "typedoc": "^0.27.9",
-    "typescript": "^5.8.2"
-  },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node",
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "src/**/*.ts",
-      "!src/**/*.d.ts"
-    ]
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.8"
   },
   "typedocOptions": {
     "entryPoints": [
       "./src"
     ],
-    "tsconfig": "./tsconfig.build.json"
+    "tsconfig": "./tsconfig.json"
   },
   "release": {
     "plugins": [