create-minimal-package 1.2.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -4
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -6,7 +6,9 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
6
6
 
7
7
  **Docs Demo**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
8
8
 
9
- **Package Demo**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
9
+ **NPM Package Demo**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
10
+
11
+ **Source Code**: [https://github.com/34j/create-minimal-package](https://github.com/34j/create-minimal-package)
10
12
 
11
13
  ---
12
14
 
@@ -22,8 +24,10 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
22
24
  - [🧱Renovate](https://docs.renovatebot.com/): inherits [config:best-practices](https://docs.renovatebot.com/presets-config/#configbest-practices)
23
25
  - [⚙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)
24
26
  - ✨️Formatting
25
- - [⚠️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)
27
+ - [⚠️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)
26
28
  - [ESLint](https://eslint.org/): inherits [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config)
29
+ - 📦Packageing
30
+ - [pnpm](https://pnpm.io/) (⏪️npm)
27
31
  - ⚠️ Testing
28
32
  - [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)): 0 lines
29
33
  - 📖Documentation
@@ -75,9 +79,9 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
75
79
 
76
80
  **Documentation**: [https://34j.github.io/create-minimal-package/](https://34j.github.io/create-minimal-package/)
77
81
 
78
- **Source Code**: [https://github.com/34j/create-minimal-package](https://github.com/34j/create-minimal-package)
82
+ **NPM Package**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
79
83
 
80
- **Package**: [https://www.npmjs.com/package/create-minimal-package](https://www.npmjs.com/package/create-minimal-package)
84
+ **Source Code**: [https://github.com/34j/create-minimal-package](https://github.com/34j/create-minimal-package)
81
85
 
82
86
  ---
83
87
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "create-minimal-package",
3
3
  "type": "commonjs",
4
- "version": "1.2.0",
4
+ "version": "1.3.1",
5
5
  "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.",
6
6
  "author": {
7
7
  "name": "34j"
@@ -33,12 +33,13 @@
33
33
  },
34
34
  "scripts": {
35
35
  "build:watch": "tsc --watch --project tsconfig.json",
36
+ "preinstall": "npx only-allow pnpm",
36
37
  "build": "tsc --project tsconfig.json",
37
38
  "lint": "eslint --fix",
38
39
  "typedoc": "typedoc",
39
40
  "typedoc:watch": "typedoc --watch",
40
- "test:watch": "vitest --watch",
41
- "test": "vitest --coverage",
41
+ "test:watch": "vitest --watch --coverage --coverage.include=src",
42
+ "test": "vitest --coverage --coverage.include=src",
42
43
  "watch": "npm-run-all --race --parallel *:watch",
43
44
  "update": "npm-check-updates -u"
44
45
  },