create-minimal-package 1.3.2 → 1.4.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.
- package/README.md +8 -6
- package/package.json +12 -15
package/README.md
CHANGED
|
@@ -29,16 +29,17 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
|
|
|
29
29
|
- 📦Packageing
|
|
30
30
|
- [pnpm](https://pnpm.io/) (⏪️npm)
|
|
31
31
|
- ⚠️ Testing
|
|
32
|
-
- [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)):
|
|
32
|
+
- [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)): several lines for browser testing (optional, can be removed if Node.js only)
|
|
33
33
|
- 📖Documentation
|
|
34
34
|
- [🌐GitHub Pages](https://pages.github.com/)
|
|
35
35
|
- [📖TypeDoc](https://typedoc.org/): 2 lines for `☆` `P`
|
|
36
|
+
- ❄Nix Support (Optional, only needed for Nix users)
|
|
37
|
+
- [❄`nix develop --ignore-environment`](https://nix.dev/manual/nix/latest/command-ref/new-cli/nix3-develop): many lines for Playwright support (optional, can be removed if Node.js only)
|
|
36
38
|
|
|
37
39
|
<details>
|
|
38
40
|
<summary>Removed Features (to achieve minimalism)</summary>
|
|
39
41
|
|
|
40
42
|
- Removed Commitizen integration and VS Code stuff (from [ryansonshine/typescript-npm-package-template](https://github.com/ryansonshine/typescript-npm-package-template)) because it's not maintained and complex. Commitizen can be still used (Semantic Release supports it natively).
|
|
41
|
-
- Removed Nix stuff and typedoc-plugin-markdown (from [typescript-npm-package-template](https://github.com/Atry/typescript-npm-package-template/tree/main)) because it's not necessary.
|
|
42
43
|
- Removed Prettier due to [@antfu/eslint-config's opinions](https://github.com/antfu/eslint-config?tab=readme-ov-file#prettier) and [mirrors-prettier](https://github.com/pre-commit/mirrors-prettier) being archived.
|
|
43
44
|
|
|
44
45
|
</details>
|
|
@@ -50,14 +51,15 @@ Zero-knowledge ***minimalistic*** template for creating a new npm package.
|
|
|
50
51
|
```bash
|
|
51
52
|
GITHUB_USER="johnsmith"
|
|
52
53
|
REPO_NAME="my-cool-package"
|
|
53
|
-
sed -i.tmp "s/\([^@]\)34j/\1$GITHUB_USER/g; s/create-minimal-package\|my-package-name/$REPO_NAME/g; package.json
|
|
54
|
+
sed -i.tmp "s/\([^@]\)34j/\1$GITHUB_USER/g; s/create-minimal-package\|my-package-name/$REPO_NAME/g;" package.json src/index.ts README.md
|
|
54
55
|
sed -i.tmp 's/"version": "[0-9.]*"/"version": "0.0.0"/' package.json
|
|
55
56
|
rm *.tmp
|
|
57
|
+
rm src/*.tmp
|
|
56
58
|
rm CHANGELOG.md
|
|
57
59
|
```
|
|
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
|
-
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).
|
|
60
|
+
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).
|
|
61
|
+
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).
|
|
62
|
+
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
63
|
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
64
|
7. Remove everything above `---`.
|
|
63
65
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-minimal-package",
|
|
3
3
|
"type": "commonjs",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.4.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"
|
|
@@ -28,9 +28,6 @@
|
|
|
28
28
|
"files": [
|
|
29
29
|
"dist/**/*"
|
|
30
30
|
],
|
|
31
|
-
"engines": {
|
|
32
|
-
"node": ">=12.0"
|
|
33
|
-
},
|
|
34
31
|
"scripts": {
|
|
35
32
|
"build:watch": "tsc --watch --project tsconfig.json",
|
|
36
33
|
"preinstall": "npx only-allow pnpm",
|
|
@@ -44,21 +41,21 @@
|
|
|
44
41
|
"update": "npm-check-updates -u"
|
|
45
42
|
},
|
|
46
43
|
"devDependencies": {
|
|
47
|
-
"@antfu/eslint-config": "4.
|
|
44
|
+
"@antfu/eslint-config": "4.11.0",
|
|
48
45
|
"@semantic-release/changelog": "6.0.3",
|
|
49
46
|
"@semantic-release/git": "10.0.1",
|
|
50
47
|
"@tsconfig/strictest": "2.0.5",
|
|
51
|
-
"@types/node": "22.
|
|
52
|
-
"@typescript-eslint/eslint-plugin": "8.
|
|
53
|
-
"@vitest/
|
|
54
|
-
"
|
|
55
|
-
"
|
|
56
|
-
"npm-
|
|
57
|
-
"
|
|
48
|
+
"@types/node": "22.14.0",
|
|
49
|
+
"@typescript-eslint/eslint-plugin": "8.29.0",
|
|
50
|
+
"@vitest/browser": "3.1.1",
|
|
51
|
+
"@vitest/coverage-v8": "3.1.1",
|
|
52
|
+
"eslint": "9.24.0",
|
|
53
|
+
"npm-run-all2": "7.0.2",
|
|
54
|
+
"playwright": "1.51.1",
|
|
58
55
|
"semantic-release": "24.2.3",
|
|
59
|
-
"typedoc": "0.
|
|
60
|
-
"typescript": "5.8.
|
|
61
|
-
"vitest": "3.
|
|
56
|
+
"typedoc": "0.28.1",
|
|
57
|
+
"typescript": "5.8.3",
|
|
58
|
+
"vitest": "3.1.1"
|
|
62
59
|
},
|
|
63
60
|
"typedocOptions": {
|
|
64
61
|
"entryPoints": [
|