@anansi/cli 3.1.97 → 3.1.98

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 (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +73 -18
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.1.98](/github.com/ntucker/anansi/compare/@anansi/cli@3.1.97...@anansi/cli@3.1.98) (2026-01-02)
7
+
8
+ ### 📝 Documentation
9
+
10
+ * Update readme ([b42d500](/github.com/ntucker/anansi/commit/b42d50069157979ac2c21fce92c4750f3219461a))
11
+
6
12
  ## [3.1.97](/github.com/ntucker/anansi/compare/@anansi/cli@3.1.96...@anansi/cli@3.1.97) (2025-12-31)
7
13
 
8
14
  **Note:** Version bump only for package @anansi/cli
package/README.md CHANGED
@@ -25,12 +25,12 @@ Like Ubuntu did for Linux; Anansi focuses on bringing together many powerful too
25
25
 
26
26
  ## Installation
27
27
 
28
- <details><summary><b><a href="https://nodejs.org/">node.js</a> >=10 and <a href="https://www.npmjs.com/">npm</a> >=6 are required.</b></summary>
28
+ <details><summary><b><a href="https://nodejs.org/">node.js</a> ^18.17.0 or >=20.5.0 and <a href="https://www.npmjs.com/">npm</a> >=6 are required.</b></summary>
29
29
 
30
30
  Use [nvm](https://github.com/nvm-sh/nvm) to install these if you don't already.
31
31
 
32
32
  ```bash
33
- wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
33
+ wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
34
34
  ```
35
35
  </details>
36
36
 
@@ -48,38 +48,93 @@ anansi hatch my-app-name
48
48
 
49
49
  This creates a `my-app-name` directory in your current directory and sets up the project there.
50
50
 
51
- ## Updates
51
+ ## Commands
52
52
 
53
- Features can be incrementally adopted by running sub-generators from an existing project directory.
53
+ ### hatch
54
+
55
+ Creates a new Anansi project.
56
+
57
+ ```
58
+ Usage: anansi hatch [options] <projectName>
59
+
60
+ Aliases: init
61
+
62
+ Arguments:
63
+ projectName Package name for the project
64
+
65
+ Options:
66
+ -d, --dir <directory> What directory to add to. (Creates new directory by default)
67
+ ```
68
+
69
+ The interactive wizard will prompt you to choose:
70
+ - **Project type**: Website (SPA) or NPM package (library)
71
+ - **GitHub org/username**: For repository configuration
72
+
73
+ ```bash
74
+ anansi hatch my-app-name
75
+ ```
76
+
77
+ ### add
78
+
79
+ Adds features to an existing project.
80
+
81
+ ```
82
+ Usage: anansi add <features...>
54
83
 
55
- ### E.g., Adding Testing
84
+ Arguments:
85
+ features One or more of: testing | storybook | circle | github-actions
86
+ ```
56
87
 
57
- ```shell
88
+ Features can be incrementally adopted by running sub-generators from an existing project directory.
89
+
90
+ ```bash
58
91
  cd my-app-name
59
92
  anansi add testing
93
+ anansi add storybook circle
60
94
  ```
61
95
 
62
- ## Running SSR
96
+ Available features:
97
+ - `testing` - Jest testing setup
98
+ - `storybook` - Storybook component documentation
99
+ - `circle` - CircleCI configuration
100
+ - `github-actions` - GitHub Actions workflow
63
101
 
64
- ```bash
65
- Usage: anansi serve [options] <entrypath>
102
+ ### serve
103
+
104
+ Runs server for SSR (Server-Side Rendering) projects. Requires `@anansi/core` to be installed.
66
105
 
67
- runs server for SSR projects
106
+ ```
107
+ Usage: anansi serve [options] <entrypath>
68
108
 
69
109
  Arguments:
70
- entrypath Path to entrypoint
110
+ entrypath Path to entrypoint
71
111
 
72
112
  Options:
73
- --pubPath <path> Where to serve assets from
74
- -d, --dev Run devserver rather than using previously compiled output
75
- -a, --serveAssets [non-dev] also serves client assets
76
- -p, --serveProxy [non-dev] uses webpack proxy config
77
- -h, --help display help for command
113
+ --pubPath <path> Where to serve assets from
114
+ -d, --dev Run devserver rather than using previously compiled output
115
+ -a, --serveAssets [non-dev] also serves client assets
116
+ -p, --serveProxy [non-dev] uses webpack proxy config
78
117
  ```
79
118
 
119
+ **Development mode:**
120
+
121
+ ```bash
122
+ anansi serve --dev ./src/index.tsx
123
+ ```
124
+
125
+ **Production mode (using pre-compiled output):**
126
+
127
+ ```bash
128
+ anansi serve ./dist-server/App.js
129
+ ```
130
+
131
+ **Example package.json scripts:**
132
+
80
133
  ```json
81
134
  {
82
- "start": "anansi serve --dev ./src/index.tsx",
83
- "start:server": "anansi serve ./dist-server/App.js",
135
+ "scripts": {
136
+ "start": "anansi serve --dev ./src/index.tsx",
137
+ "start:server": "anansi serve ./dist-server/App.js"
138
+ }
84
139
  }
85
140
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anansi/cli",
3
- "version": "3.1.97",
3
+ "version": "3.1.98",
4
4
  "description": "Fast React Web Apps",
5
5
  "homepage": "https://github.com/ntucker/anansi/tree/master/packages/cli#readme",
6
6
  "repository": {
@@ -51,7 +51,7 @@
51
51
  "npm": ">= 6.0.0"
52
52
  },
53
53
  "devDependencies": {
54
- "@anansi/core": "^0.22.2",
54
+ "@anansi/core": "^0.22.3",
55
55
  "@types/node": "^24.0.0"
56
56
  },
57
57
  "dependencies": {