create-minimal-package 1.4.1 → 1.5.1

package/README.md

@@ -61,7 +61,8 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
 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. Remove everything above `---`.
+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 `---`.
 
 > 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.
 

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/index.js

@@ -3,7 +3,9 @@
   @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.myPackage = void 0;
+exports.mySubmodule = exports.myPackage = void 0;
+const submodule_1 = require("./submodule");
+Object.defineProperty(exports, "mySubmodule", { enumerable: true, get: function () { return submodule_1.mySubmodule; } });
 /**
  * Lorem ipsum.
  */

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

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

package/dist/src/submodule/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mySubmodule = void 0;
+/**
+ * Lorem ipsum.
+ */
+const mySubmodule = (taco = '') => `${taco} from my submodule`;
+exports.mySubmodule = mySubmodule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-minimal-package",
   "type": "commonjs",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "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.11.0",
+    "@antfu/eslint-config": "4.12.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@tsconfig/strictest": "2.0.5",
-    "@types/node": "22.14.0",
-    "@typescript-eslint/eslint-plugin": "8.29.0",
+    "@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.1",
+    "typedoc": "0.28.2",
     "typescript": "5.8.3",
     "vitest": "3.1.1"
   },
   "typedocOptions": {
     "entryPoints": [
-      "./src"
+      "src"
     ],
-    "tsconfig": "./tsconfig.json"
+    "tsconfig": "tsconfig.json",
+    "headings": false
   },
   "release": {
     "plugins": [

package/dist/test/index.spec.js

@@ -1,13 +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);
-        });
-    });
-});