create-minimal-package 1.3.1 → 1.3.2
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.
- package/README.md +5 -5
- package/package.json +16 -16
package/README.md
CHANGED
|
@@ -45,8 +45,8 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
|
|
|
45
45
|
|
|
46
46
|
## Quickstart
|
|
47
47
|
|
|
48
|
-
1.
|
|
49
|
-
2. Replace `
|
|
48
|
+
1. Click the "Use this template" button.
|
|
49
|
+
2. Replace `GITHUB_USER` and `REPO_NAME` using `sed`:
|
|
50
50
|
```bash
|
|
51
51
|
GITHUB_USER="johnsmith"
|
|
52
52
|
REPO_NAME="my-cool-package"
|
|
@@ -55,10 +55,10 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
|
|
|
55
55
|
rm *.tmp
|
|
56
56
|
rm CHANGELOG.md
|
|
57
57
|
```
|
|
58
|
-
3.
|
|
59
|
-
4.
|
|
58
|
+
3. [Create](https://www.npmjs.com/) and add `NPM_TOKEN` to `Settings/Secrets and variables/Actions/Repository secrets`.
|
|
59
|
+
4. [Create][codecov-url] and add `CODECOV_TOKEN` to `Settings/Secrets and variables/Actions/Repository secrets`.
|
|
60
60
|
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).
|
|
61
|
-
6. Install [pre-commit](https://pre-commit.com/) using [`uv`](https://github.com/astral-sh/uv)
|
|
61
|
+
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`.
|
|
62
62
|
7. Remove everything above `---`.
|
|
63
63
|
|
|
64
64
|
> 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/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-minimal-package",
|
|
3
3
|
"type": "commonjs",
|
|
4
|
-
"version": "1.3.
|
|
4
|
+
"version": "1.3.2",
|
|
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"
|
|
@@ -44,21 +44,21 @@
|
|
|
44
44
|
"update": "npm-check-updates -u"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@antfu/eslint-config": "
|
|
48
|
-
"@semantic-release/changelog": "
|
|
49
|
-
"@semantic-release/git": "
|
|
50
|
-
"@tsconfig/strictest": "
|
|
51
|
-
"@types/node": "
|
|
52
|
-
"@typescript-eslint/eslint-plugin": "
|
|
53
|
-
"@vitest/coverage-v8": "
|
|
54
|
-
"eslint": "
|
|
55
|
-
"globals": "
|
|
56
|
-
"npm-check-updates": "
|
|
57
|
-
"npm-run-all2": "5.0.
|
|
58
|
-
"semantic-release": "
|
|
59
|
-
"typedoc": "
|
|
60
|
-
"typescript": "
|
|
61
|
-
"vitest": "
|
|
47
|
+
"@antfu/eslint-config": "4.10.1",
|
|
48
|
+
"@semantic-release/changelog": "6.0.3",
|
|
49
|
+
"@semantic-release/git": "10.0.1",
|
|
50
|
+
"@tsconfig/strictest": "2.0.5",
|
|
51
|
+
"@types/node": "22.13.10",
|
|
52
|
+
"@typescript-eslint/eslint-plugin": "8.26.1",
|
|
53
|
+
"@vitest/coverage-v8": "3.0.8",
|
|
54
|
+
"eslint": "9.22.0",
|
|
55
|
+
"globals": "16.0.0",
|
|
56
|
+
"npm-check-updates": "17.1.15",
|
|
57
|
+
"npm-run-all2": "5.0.2",
|
|
58
|
+
"semantic-release": "24.2.3",
|
|
59
|
+
"typedoc": "0.27.9",
|
|
60
|
+
"typescript": "5.8.2",
|
|
61
|
+
"vitest": "3.0.8"
|
|
62
62
|
},
|
|
63
63
|
"typedocOptions": {
|
|
64
64
|
"entryPoints": [
|