fabrique 0.3.3 → 0.3.5

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/.yarnrc.yml CHANGED
@@ -3,4 +3,4 @@ nodeLinker: node-modules
3
3
  unsafeHttpWhitelist:
4
4
  - localhost
5
5
 
6
- yarnPath: .yarn/releases/yarn-4.7.0.cjs
6
+ yarnPath: .yarn/releases/yarn-4.8.1.cjs
package/README.md CHANGED
@@ -47,7 +47,7 @@ The library requires [Node.js](https://nodejs.org/en) `22+` and [yarn](https://y
47
47
  We recommend to use [npx](https://docs.npmjs.com/cli/v8/commands/npx):
48
48
 
49
49
  ```shell
50
- npx fabrique [CMD]
50
+ npx fabrique [cmd]
51
51
  ```
52
52
 
53
53
  But, you may prefer to install globally `fabrique`:
@@ -58,36 +58,41 @@ npm install -g fabrique
58
58
  And run a command with:
59
59
 
60
60
  ```shell
61
- fabrique [CMD]
61
+ fabrique [cmd]
62
62
  ```
63
63
 
64
64
 
65
65
  ### List of commands
66
66
 
67
- #### create
67
+ #### \[cmd\]: create
68
68
 
69
69
  ```shell
70
- npx fabrique create lib [name]
70
+ npx fabrique create [type] [name]
71
71
  ```
72
72
 
73
- ##### example
73
+ ##### \[type\]: lib
74
+
75
+ ###### example
74
76
 
75
77
  ```shell
76
78
  npx fabrique create lib @my-company/my-library
77
79
  ```
78
80
 
79
- ##### action
81
+ ###### action
80
82
 
81
83
  This command creates a new library with the name `[name]` inside the folder `./[name]` (in our example: `./@my-company/my-library`).
82
84
  You'll be prompted for a description, author and git url.
83
85
 
84
86
  > INFO: run the command where you want to create your project.
85
87
 
86
- ##### options
88
+ ###### options
87
89
 
88
90
  - `[name]`: the library name
89
91
 
90
- #### upgrade
92
+
93
+ > NOTE: currently only the `lib` type is supported. More architectures may be developed in the future.
94
+
95
+ #### \[cmd\]: upgrade
91
96
 
92
97
  ```shell
93
98
  # from the root of a "fabrique" project
@@ -105,7 +110,7 @@ It tries to be non-destructive.
105
110
 
106
111
  - `--force`: forces an upgrade even if the lib is not a `fabrique` project or if the version is identical. _Use with caution._
107
112
 
108
- #### refactor
113
+ #### \[cmd\]: refactor
109
114
 
110
115
  ```shell
111
116
  # from the directory we want to refactor
@@ -171,7 +176,7 @@ It preserves the case of the names (ex: `dash-case`, or `cameCase`).
171
176
  - `--dry` (default: false): runs without modifying the files. This is useful to check if your refactoring is safe or not.
172
177
  - `--cwd` (default: current folder): specifies the directory to start from.
173
178
 
174
- #### verdaccio
179
+ #### \[cmd\]: verdaccio
175
180
 
176
181
  ```shell
177
182
  npx fabrique verdaccio
@@ -192,7 +197,7 @@ then, we'll consume this dev version on `my-lib-b`.
192
197
  > Thus, we may have `my-lib-b` consuming `my-lib-a-dev.0` and `my-lib-c` consuming `my-lib-a-dev.1`, which is not possible with `npm link`.
193
198
 
194
199
 
195
- #### version
200
+ #### --version
196
201
 
197
202
  ```shell
198
203
  npx fabrique --version
@@ -202,7 +207,7 @@ npx fabrique -v
202
207
 
203
208
  Returns the current `fabrique` version.
204
209
 
205
- #### help
210
+ #### --help
206
211
 
207
212
  ```shell
208
213
  npx fabrique --help
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fabrique",
3
- "version": "0.3.3",
3
+ "version": "0.3.5",
4
4
  "type": "module",
5
5
  "main": "./src/index.js",
6
6
  "bin": "./src/index.js",
@@ -19,9 +19,9 @@
19
19
  "type": "git",
20
20
  "url": "https://github.com/lifaon74/fabrique"
21
21
  },
22
- "packageManager": "yarn@4.7.0",
22
+ "packageManager": "yarn@4.8.1",
23
23
  "devDependencies": {
24
- "@inquirer/prompts": "^7.4.0",
24
+ "@inquirer/prompts": "^7.4.1",
25
25
  "prettier": "^3.5.3",
26
26
  "prettier-plugin-organize-imports": "^4.1.0",
27
27
  "typescript": "^5.8.2"