create-minimal-package 1.5.0 → 1.5.2

package/README.md

@@ -4,11 +4,9 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
 
 ---
 
-**Docs Demo**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
+**📘Docs Demo**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
 
-**NPM Package Demo**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
-
-**Source Code**: [https://github.com/34j/create-minimal-package](https://github.com/34j/create-minimal-package)
+**📦️NPM Package Demo**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
 
 ---
 
@@ -28,6 +26,7 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
   - [ESLint](https://eslint.org/): inherits [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config)
 - 📦Packageing
   - [pnpm](https://pnpm.io/) (⏪️npm)
+  - [🛡️Trusted Publishing](https://docs.npmjs.com/trusted-publishers)
 - ⚠️ Testing
   - [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)): several lines for browser testing (optional, can be removed if Node.js only)
 - 📖Documentation
@@ -44,8 +43,19 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
 
 </details>
 
-## Quickstart
+## Quickstart (Copier)
+
+```shell
+uvx copier copy --trust "gh:34j/create-minimal-package" --vcs-ref main my-cool-package
+🎤 What is your project name?
+   my-cool-package
+🎤 What is your GitHub username?
+   34j
+```
+
+## Quickstart (GitHub Template)
 
+0. Run `npx setup-npm-trusted-publish my-cool-package` to reserve the package name and allow trusted publishing.
 1. Click the "Use this template" button.
 2. Replace `GITHUB_USER` and `REPO_NAME` using `sed`:
   ```bash
@@ -56,16 +66,18 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
   rm *.tmp
   rm src/*.tmp
   rm CHANGELOG.md
+  rm *.jinja
   ```
-3. [Create](https://www.npmjs.com/settings/34j/tokens/) and add `NPM_TOKEN` to [`Settings/Secrets and variables/Actions/Repository secrets`](https://github.com/34j/create-minimal-package/settings/secrets/actions).
-4. [Create][codecov-url] and add `CODECOV_TOKEN` to [`Settings/Secrets and variables/Actions/Repository secrets`](https://github.com/34j/create-minimal-package/settings/secrets/actions).
-5. Install GitHub Apps, [pre-commit.ci **lite**](https://github.com/apps/pre-commit-ci-lite/installations/select_target) and [Codecov](https://github.com/apps/codecov/installations/select_target).
-6. Install [pre-commit](https://pre-commit.com/) using [`uv`](https://github.com/astral-sh/uv) by `uv tool install pre-commit` and install hooks by `pre-commit install`.
-7. Enable Github Pages and set `Source` to `GitHub Actions` from [`Settings/Pages/Build and deployment`](https://github.com/34j/create-minimal-package/settings/pages)
-8. Remove everything above `---`.
+3. Install GitHub Apps, [pre-commit.ci **lite**](https://github.com/apps/pre-commit-ci-lite/installations/select_target) and [Codecov](https://github.com/apps/codecov/installations/select_target).
+4. Install [pre-commit](https://pre-commit.com/) using [`uv`](https://github.com/astral-sh/uv) by `uv tool install pre-commit` and install hooks by `pre-commit install`.
+5. Enable Github Pages and set `Source` to `GitHub Actions` from [`Settings/Pages/Build and deployment`](https://github.com/34j/create-minimal-package/settings/pages)
+6. Remove everything above `---`.
 
 > Inspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate) and [typescript-npm-package-template](https://github.com/Atry/typescript-npm-package-template/tree/main), which is great but unnecessarily complex and poorly maintained.
 
+- Enable [Token authentication for public repositories](https://docs.codecov.com/docs/codecov-tokens#uploading-without-a-token) to upload coverage reports without a token.
+
+---
 ---
 
 # create-minimal-package
@@ -80,11 +92,9 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
 
 ---
 
-**Documentation**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
-
-**NPM Package**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
+**📘Documentation**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
 
-**Source Code**: [https://github.com/34j/create-minimal-package](https://github.com/34j/create-minimal-package)
+**📦️NPM Package**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
 
 ---
 

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+/**
+  @module
+ */
+import { mySubmodule } from './submodule';
+/**
+ * Lorem ipsum.
+ */
+export declare const myPackage: (taco?: string) => string;
+export { mySubmodule };

package/dist/src/submodule/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Lorem ipsum.
+ */
+export declare const mySubmodule: (taco?: string) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-minimal-package",
   "type": "commonjs",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "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"
@@ -24,9 +24,10 @@
     "semantic-release",
     "typedoc"
   ],
-  "main": "./dist/index.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "files": [
-    "dist/**/*"
+    "dist/src/**/*"
   ],
   "scripts": {
     "build:watch": "tsc --watch --project tsconfig.json",
@@ -41,27 +42,28 @@
     "update": "npm-check-updates -u"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "4.12.0",
+    "@antfu/eslint-config": "6.0.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@tsconfig/strictest": "2.0.5",
-    "@types/node": "22.14.1",
-    "@typescript-eslint/eslint-plugin": "8.29.1",
-    "@vitest/browser": "3.1.1",
-    "@vitest/coverage-v8": "3.1.1",
-    "eslint": "9.24.0",
-    "npm-run-all2": "7.0.2",
-    "playwright": "1.51.1",
-    "semantic-release": "24.2.3",
-    "typedoc": "0.28.2",
-    "typescript": "5.8.3",
-    "vitest": "3.1.1"
+    "@tsconfig/strictest": "2.0.6",
+    "@types/node": "22.18.12",
+    "@typescript-eslint/eslint-plugin": "8.46.2",
+    "@vitest/browser": "3.2.4",
+    "@vitest/coverage-v8": "3.2.4",
+    "eslint": "9.38.0",
+    "npm-run-all2": "8.0.4",
+    "playwright": "1.56.1",
+    "semantic-release": "25.0.1",
+    "typedoc": "0.28.14",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4"
   },
   "typedocOptions": {
     "entryPoints": [
-      "./src"
+      "src"
     ],
-    "tsconfig": "./tsconfig.json"
+    "tsconfig": "tsconfig.json",
+    "headings": false
   },
   "release": {
     "plugins": [

package/dist/test/index.spec.js

@@ -1,20 +0,0 @@
-"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);
-        });
-    });
-    (0, vitest_1.describe)('mySubmodule', () => {
-        (0, vitest_1.it)('should return a string containing the message', () => {
-            const message = 'Hello';
-            const result = (0, src_1.mySubmodule)(message);
-            (0, vitest_1.expect)(result).toMatch(message);
-        });
-    });
-});