gotchi-generator 1.0.0 → 1.0.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 +28 -0
  2. package/package.json +9 -2
package/README.md CHANGED
@@ -55,6 +55,34 @@ gotchi-generator/
55
55
  npm install gotchi-generator
56
56
  ```
57
57
 
58
+ ### Installing in monorepos and pnpm workspaces
59
+
60
+ If your repository uses pnpm or a pnpm workspace layout (presence of `pnpm-lock.yaml` and `node_modules/.pnpm`):
61
+
62
+ ```bash
63
+ # At the workspace root
64
+ corepack enable
65
+ pnpm add -w gotchi-generator
66
+
67
+ # Or add to a specific package only
68
+ pnpm -F <package-name> add gotchi-generator
69
+ ```
70
+
71
+ Using npm inside a pnpm-managed workspace can cause npm to crash with an internal Arborist error like:
72
+
73
+ ```text
74
+ TypeError: Cannot read properties of null (reading 'matches')
75
+ ```
76
+
77
+ If you must use npm in such a workspace, either install from a leaf package directory (not the workspace root) or use the nested strategy:
78
+
79
+ ```bash
80
+ # from the package directory
81
+ npm install gotchi-generator --install-strategy=nested
82
+ ```
83
+
84
+ Package details: [gotchi-generator on npm](https://www.npmjs.com/package/gotchi-generator)
85
+
58
86
  ESM:
59
87
 
60
88
  ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gotchi-generator",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Generate sprite sheets for Aavegotchis with viewer",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -24,7 +24,10 @@
24
24
  "scripts": {
25
25
  "generate": "tsx src/generate_spritesheets.ts",
26
26
  "build": "tsup",
27
- "prepublishOnly": "npm run build"
27
+ "prepublishOnly": "npm run build",
28
+ "release:patch": "npm version patch -m \"chore(release): %s\" && npm publish --access public",
29
+ "release:minor": "npm version minor -m \"chore(release): %s\" && npm publish --access public",
30
+ "release:major": "npm version major -m \"chore(release): %s\" && npm publish --access public"
28
31
  },
29
32
  "dependencies": {
30
33
  "sharp": "^0.33.0"
@@ -37,5 +40,9 @@
37
40
  },
38
41
  "engines": {
39
42
  "node": ">=18"
43
+ },
44
+ "publishConfig": {
45
+ "access": "public",
46
+ "registry": "https://registry.npmjs.org/"
40
47
  }
41
48
  }