Skip to content

Commit 35eaf5d

Browse files
bertdeblockbertdeblock
committed
Generate usage
1 parent a691543 commit 35eaf5d

File tree

5 files changed

+276
-54
lines changed

5 files changed

+276
-54
lines changed

‎README.md‎

Lines changed: 223 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -56,87 +56,233 @@ yarn add -D @bertdeblock/gember
5656

5757
## Usage
5858

59+
### gember
60+
5961
```shell
60-
Generate components, helpers, modifiers and services in v1/v2 apps/addons.
62+
Generate components, helpers, modifiers and services in v1/v2 apps/addons. (gember v1.4.0)
6163

62-
USAGE gember component|component-test|helper|helper-test|modifier|modifier-test|service|service-test|acceptance-test
64+
USAGE `gember component|component-test|helper|helper-test|modifier|modifier-test|service|service-test|acceptance-test`
6365

6466
COMMANDS
6567

66-
component Generate a new component
67-
component-test Generate a new component-test
68-
helper Generate a new helper
69-
helper-test Generate a new helper-test
70-
modifier Generate a new modifier
71-
modifier-test Generate a new modifier-test
72-
service Generate a new service
73-
service-test Generate a new service-test
74-
acceptance-test Generate a new acceptance-test
75-
76-
Use gember <command> --help for more information about a command.
68+
`component` Generate a new component
69+
`component-test` Generate a new component-test
70+
`helper` Generate a new helper
71+
`helper-test` Generate a new helper-test
72+
`modifier` Generate a new modifier
73+
`modifier-test` Generate a new modifier-test
74+
`service` Generate a new service
75+
`service-test` Generate a new service-test
76+
`acceptance-test` Generate a new acceptance-test
77+
78+
Use `gember <command> --help` for more information about a command.
7779
```
7880

79-
💡 Run `pnpm gember` to run generators interactively.
81+
### component
8082

81-
<details open>
82-
<summary>Generating components</summary>
83+
```shell
84+
Generate a new component (component)
85+
86+
USAGE `component [OPTIONS] <NAME>`
87+
88+
ARGUMENTS
89+
90+
`NAME` The component's name
91+
92+
OPTIONS
93+
94+
`-class, -class-based, --classBased` Generate a `class-based` component, instead of a `template-only` component
95+
`--copy` Copy the generated component to the clipboard, instead of writing it to disk
96+
`--cwd` The current working directory to run the component generator in
97+
`-d, --destroy` Destroy a component by name
98+
`--log` Log the generated component to the console, instead of writing it to disk
99+
`--nested` Generate a nested colocated component, e.g. `foo/bar/index.gts`
100+
`--path` Generate a component at a custom path, e.g. `--path=src/-private`
101+
`--test` Generate a corresponding component-test
102+
`-gts, -ts, --typescript` Generate a `.gts` component, instead of a `.gjs` component
103+
104+
```
105+
106+
### component-test
83107
84108
```shell
85-
pnpm gember component --help # for all available options
86-
87-
# examples:
88-
pnpm gember component foo
89-
pnpm gember component foo --class-based # or `--class`
90-
pnpm gember component foo --nested
91-
pnpm gember component foo --path="src/-private"
92-
pnpm gember component foo --typescript # or `--ts`
109+
Generate a new component-test (component-test)
110+
111+
USAGE `component-test [OPTIONS] <NAME>`
112+
113+
ARGUMENTS
114+
115+
`NAME` The component-test's name
116+
117+
OPTIONS
118+
119+
`--copy` Copy the generated component-test to the clipboard, instead of writing it to disk
120+
`--cwd` The current working directory to run the component-test generator in
121+
`-d, --destroy` Destroy a component-test by name
122+
`--log` Log the generated component-test to the console, instead of writing it to disk
123+
`--path` Generate a component-test at a custom path, e.g. `--path=src/-private`
124+
`-gts, -ts, --typescript` Generate a `.gts` component-test, instead of a `.gjs` component-test
125+
93126
```
94127

95-
</details>
128+
### helper
96129

97-
<details>
98-
<summary>Generating helpers</summary>
130+
```shell
131+
Generate a new helper (helper)
132+
133+
USAGE `helper [OPTIONS] <NAME>`
134+
135+
ARGUMENTS
136+
137+
`NAME` The helper's name
138+
139+
OPTIONS
140+
141+
`-class, -class-based, --classBased` Generate a `class-based` helper, instead of a `function-based` helper
142+
`--copy` Copy the generated helper to the clipboard, instead of writing it to disk
143+
`--cwd` The current working directory to run the helper generator in
144+
`-d, --destroy` Destroy a helper by name
145+
`--log` Log the generated helper to the console, instead of writing it to disk
146+
`--path` Generate a helper at a custom path, e.g. `--path=src/-private`
147+
`--test` Generate a corresponding helper-test
148+
`-ts, --typescript` Generate a `.ts` helper, instead of a `.js` helper
149+
150+
```
151+
152+
### helper-test
99153
100154
```shell
101-
pnpm gember helper --help # for all available options
155+
Generate a new helper-test (helper-test)
156+
157+
USAGE `helper-test [OPTIONS] <NAME>`
158+
159+
ARGUMENTS
160+
161+
`NAME` The helper-test's name
162+
163+
OPTIONS
164+
165+
`--copy` Copy the generated helper-test to the clipboard, instead of writing it to disk
166+
`--cwd` The current working directory to run the helper-test generator in
167+
`-d, --destroy` Destroy a helper-test by name
168+
`--log` Log the generated helper-test to the console, instead of writing it to disk
169+
`--path` Generate a helper-test at a custom path, e.g. `--path=src/-private`
170+
`-gts, -ts, --typescript` Generate a `.gts` helper-test, instead of a `.gjs` helper-test
102171

103-
# examples:
104-
pnpm gember helper foo
105-
pnpm gember helper foo --class-based # or `--class`
106-
pnpm gember helper foo --path="src/-private"
107-
pnpm gember helper foo --typescript # or `--ts`
108172
```
109173

110-
</details>
174+
### modifier
111175

112-
<details>
113-
<summary>Generating modifiers</summary>
176+
```shell
177+
Generate a new modifier (modifier)
178+
179+
USAGE `modifier [OPTIONS] <NAME>`
180+
181+
ARGUMENTS
182+
183+
`NAME` The modifier's name
184+
185+
OPTIONS
186+
187+
`-class, -class-based, --classBased` Generate a `class-based` modifier, instead of a `function-based` modifier
188+
`--copy` Copy the generated modifier to the clipboard, instead of writing it to disk
189+
`--cwd` The current working directory to run the modifier generator in
190+
`-d, --destroy` Destroy a modifier by name
191+
`--log` Log the generated modifier to the console, instead of writing it to disk
192+
`--path` Generate a modifier at a custom path, e.g. `--path=src/-private`
193+
`--test` Generate a corresponding modifier-test
194+
`-ts, --typescript` Generate a `.ts` modifier, instead of a `.js` modifier
195+
196+
```
197+
198+
### modifier-test
114199
115200
```shell
116-
pnpm gember modifier --help # for all available options
201+
Generate a new modifier-test (modifier-test)
202+
203+
USAGE `modifier-test [OPTIONS] <NAME>`
204+
205+
ARGUMENTS
206+
207+
`NAME` The modifier-test's name
208+
209+
OPTIONS
210+
211+
`--copy` Copy the generated modifier-test to the clipboard, instead of writing it to disk
212+
`--cwd` The current working directory to run the modifier-test generator in
213+
`-d, --destroy` Destroy a modifier-test by name
214+
`--log` Log the generated modifier-test to the console, instead of writing it to disk
215+
`--path` Generate a modifier-test at a custom path, e.g. `--path=src/-private`
216+
`-gts, -ts, --typescript` Generate a `.gts` modifier-test, instead of a `.gjs` modifier-test
117217

118-
# examples:
119-
pnpm gember modifier foo
120-
pnpm gember modifier foo --class-based # or `--class`
121-
pnpm gember modifier foo --path="src/-private"
122-
pnpm gember modifier foo --typescript # or `--ts`
123218
```
124219

125-
</details>
220+
### service
126221

127-
<details>
128-
<summary>Generating services</summary>
222+
```shell
223+
Generate a new service (service)
224+
225+
USAGE `service [OPTIONS] <NAME>`
226+
227+
ARGUMENTS
228+
229+
`NAME` The service's name
230+
231+
OPTIONS
232+
233+
`--copy` Copy the generated service to the clipboard, instead of writing it to disk
234+
`--cwd` The current working directory to run the service generator in
235+
`-d, --destroy` Destroy a service by name
236+
`--log` Log the generated service to the console, instead of writing it to disk
237+
`--path` Generate a service at a custom path, e.g. `--path=src/-private`
238+
`--test` Generate a corresponding service-test
239+
`-ts, --typescript` Generate a `.ts` service, instead of a `.js` service
240+
241+
```
242+
243+
### service-test
129244
130245
```shell
131-
pnpm gember service --help # for all available options
246+
Generate a new service-test (service-test)
247+
248+
USAGE `service-test [OPTIONS] <NAME>`
249+
250+
ARGUMENTS
251+
252+
`NAME` The service-test's name
253+
254+
OPTIONS
255+
256+
`--copy` Copy the generated service-test to the clipboard, instead of writing it to disk
257+
`--cwd` The current working directory to run the service-test generator in
258+
`-d, --destroy` Destroy a service-test by name
259+
`--log` Log the generated service-test to the console, instead of writing it to disk
260+
`--path` Generate a service-test at a custom path, e.g. `--path=src/-private`
261+
`-ts, --typescript` Generate a `.ts` service-test, instead of a `.js` service-test
132262

133-
# examples:
134-
pnpm gember service foo
135-
pnpm gember service foo --path="src/-private"
136-
pnpm gember service foo --typescript # or `--ts`
137263
```
138264

139-
</details>
265+
### acceptance-test
266+
267+
```shell
268+
Generate a new acceptance-test (acceptance-test)
269+
270+
USAGE `acceptance-test [OPTIONS] <NAME>`
271+
272+
ARGUMENTS
273+
274+
`NAME` The acceptance-test's name
275+
276+
OPTIONS
277+
278+
`--copy` Copy the generated acceptance-test to the clipboard, instead of writing it to disk
279+
`--cwd` The current working directory to run the acceptance-test generator in
280+
`-d, --destroy` Destroy a acceptance-test by name
281+
`--log` Log the generated acceptance-test to the console, instead of writing it to disk
282+
`--path` Generate a acceptance-test at a custom path, e.g. `--path=src/-private`
283+
`-ts, --typescript` Generate a `.ts` acceptance-test, instead of a `.js` acceptance-test
284+
285+
```
140286
141287
## Configuration
142288
@@ -175,12 +321,16 @@ export type Config = {
175321
copy?: boolean;
176322
// The current working directory to run the component generator in:
177323
cwd?: string;
324+
// Destroy a component by name:
325+
destroy?: boolean;
178326
// Log the generated component to the console, instead of writing it to disk:
179327
log?: boolean;
180328
// Generate a nested colocated component, e.g. `foo/bar/index.gts`:
181329
nested?: boolean;
182330
// Generate a component at a custom path, e.g. `--path=src/-private`:
183331
path?: string;
332+
// Generate a corresponding component-test:
333+
test?: boolean;
184334
// Generate a `.gts` component, instead of a `.gjs` component:
185335
typescript?: boolean;
186336
};
@@ -189,6 +339,8 @@ export type Config = {
189339
copy?: boolean;
190340
// The current working directory to run the component-test generator in:
191341
cwd?: string;
342+
// Destroy a component-test by name:
343+
destroy?: boolean;
192344
// Log the generated component-test to the console, instead of writing it to disk:
193345
log?: boolean;
194346
// Generate a component-test at a custom path, e.g. `--path=src/-private`:
@@ -203,10 +355,14 @@ export type Config = {
203355
copy?: boolean;
204356
// The current working directory to run the helper generator in:
205357
cwd?: string;
358+
// Destroy a helper by name:
359+
destroy?: boolean;
206360
// Log the generated helper to the console, instead of writing it to disk:
207361
log?: boolean;
208362
// Generate a helper at a custom path, e.g. `--path=src/-private`:
209363
path?: string;
364+
// Generate a corresponding helper-test:
365+
test?: boolean;
210366
// Generate a `.ts` helper, instead of a `.js` helper:
211367
typescript?: boolean;
212368
};
@@ -215,6 +371,8 @@ export type Config = {
215371
copy?: boolean;
216372
// The current working directory to run the helper-test generator in:
217373
cwd?: string;
374+
// Destroy a helper-test by name:
375+
destroy?: boolean;
218376
// Log the generated helper-test to the console, instead of writing it to disk:
219377
log?: boolean;
220378
// Generate a helper-test at a custom path, e.g. `--path=src/-private`:
@@ -229,10 +387,14 @@ export type Config = {
229387
copy?: boolean;
230388
// The current working directory to run the modifier generator in:
231389
cwd?: string;
390+
// Destroy a modifier by name:
391+
destroy?: boolean;
232392
// Log the generated modifier to the console, instead of writing it to disk:
233393
log?: boolean;
234394
// Generate a modifier at a custom path, e.g. `--path=src/-private`:
235395
path?: string;
396+
// Generate a corresponding modifier-test:
397+
test?: boolean;
236398
// Generate a `.ts` modifier, instead of a `.js` modifier:
237399
typescript?: boolean;
238400
};
@@ -241,6 +403,8 @@ export type Config = {
241403
copy?: boolean;
242404
// The current working directory to run the modifier-test generator in:
243405
cwd?: string;
406+
// Destroy a modifier-test by name:
407+
destroy?: boolean;
244408
// Log the generated modifier-test to the console, instead of writing it to disk:
245409
log?: boolean;
246410
// Generate a modifier-test at a custom path, e.g. `--path=src/-private`:
@@ -253,10 +417,14 @@ export type Config = {
253417
copy?: boolean;
254418
// The current working directory to run the service generator in:
255419
cwd?: string;
420+
// Destroy a service by name:
421+
destroy?: boolean;
256422
// Log the generated service to the console, instead of writing it to disk:
257423
log?: boolean;
258424
// Generate a service at a custom path, e.g. `--path=src/-private`:
259425
path?: string;
426+
// Generate a corresponding service-test:
427+
test?: boolean;
260428
// Generate a `.ts` service, instead of a `.js` service:
261429
typescript?: boolean;
262430
};
@@ -265,6 +433,8 @@ export type Config = {
265433
copy?: boolean;
266434
// The current working directory to run the service-test generator in:
267435
cwd?: string;
436+
// Destroy a service-test by name:
437+
destroy?: boolean;
268438
// Log the generated service-test to the console, instead of writing it to disk:
269439
log?: boolean;
270440
// Generate a service-test at a custom path, e.g. `--path=src/-private`:
@@ -277,6 +447,8 @@ export type Config = {
277447
copy?: boolean;
278448
// The current working directory to run the acceptance-test generator in:
279449
cwd?: string;
450+
// Destroy a acceptance-test by name:
451+
destroy?: boolean;
280452
// Log the generated acceptance-test to the console, instead of writing it to disk:
281453
log?: boolean;
282454
// Generate a acceptance-test at a custom path, e.g. `--path=src/-private`:

‎bin/gember.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
#!/usr/bin/env node
22

3-
import "../dist/cli.js";
3+
import { run } from "../dist/cli.js";
4+
5+
run();

0 commit comments

Comments
 (0)