Skip to content

Commit a773834

Browse files
jagoraljagoral
authored
feat!: remove generate command from cli (#7351)
1 parent d48114f commit a773834

File tree

85 files changed

+95
-2828
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+95
-2828
lines changed

Diff for: ‎.changeset/shaggy-turtles-ring.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@vue-storefront/cli": major
3+
---
4+
5+
**[REMOVED]** `generate` command. If you are an enterprise user, please check the [Getting started](https://docs.alokai.com/storefront/introduction/getting-started) page in the docs. If you are a community user, please check the example [Next.js project](https://github.com/vuestorefront/storefront-next13-boilerplate) and [Nuxt project](https://github.com/vuestorefront/storefront-nuxt3-boilerplate).

Diff for: ‎packages/cli/README.md

+89-27
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ npx @vue-storefront/cli generate template
1717
## Commands
1818

1919
<!-- commands -->
20-
* [`@vue-storefront/cli generate store`](#vue-storefrontcli-generate-store)
21-
* [`@vue-storefront/cli generate template`](#vue-storefrontcli-generate-template)
22-
* [`@vue-storefront/cli help [COMMAND]`](#vue-storefrontcli-help-command)
23-
* [`@vue-storefront/cli init`](#vue-storefrontcli-init)
20+
* [`@vue-storefront/cli add [COMMANDARG] [ENDPOINT]`](#vue-storefrontcli-add-commandarg-endpoint)
21+
* [`@vue-storefront/cli add endpoint [NAME]`](#vue-storefrontcli-add-endpoint-name)
22+
* [`@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]`](#vue-storefrontcli-create-commandname-integrationname)
23+
* [`@vue-storefront/cli create integration [NAME]`](#vue-storefrontcli-create-integration-name)
24+
* [`@vue-storefront/cli help [COMMANDS]`](#vue-storefrontcli-help-commands)
2425
* [`@vue-storefront/cli plugins`](#vue-storefrontcli-plugins)
2526
* [`@vue-storefront/cli plugins:install PLUGIN...`](#vue-storefrontcli-pluginsinstall-plugin)
2627
* [`@vue-storefront/cli plugins:inspect PLUGIN...`](#vue-storefrontcli-pluginsinspect-plugin)
@@ -32,60 +33,108 @@ npx @vue-storefront/cli generate template
3233
* [`@vue-storefront/cli plugins update`](#vue-storefrontcli-plugins-update)
3334
* [`@vue-storefront/cli update [CHANNEL]`](#vue-storefrontcli-update-channel)
3435

35-
## `@vue-storefront/cli generate store`
36+
## `@vue-storefront/cli add [COMMANDARG] [ENDPOINT]`
37+
38+
Create new endpoint boilerplate code
3639

3740
```
3841
USAGE
39-
$ @vue-storefront/cli generate store
42+
$ @vue-storefront/cli add [COMMANDARG] [ENDPOINT]
43+
44+
ARGUMENTS
45+
COMMANDARG Name of the command
46+
ENDPOINT Name of the endpoint
47+
48+
DESCRIPTION
49+
Create new endpoint boilerplate code
4050
4151
EXAMPLES
42-
$ @vue-storefront/cli generate store
52+
$ @vue-storefront/cli add <command> <endpoint>
4353
```
4454

45-
## `@vue-storefront/cli generate template`
55+
_See code: [src/commands/add/index.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/index.ts)_
56+
57+
## `@vue-storefront/cli add endpoint [NAME]`
58+
59+
Create new endpoint boilerplate code
4660

4761
```
4862
USAGE
49-
$ @vue-storefront/cli generate template [--output <value>]
63+
$ @vue-storefront/cli add endpoint [NAME]
5064
51-
FLAGS
52-
--output=<value> [default: .]
65+
ARGUMENTS
66+
NAME Name of the endpoint
67+
68+
DESCRIPTION
69+
Create new endpoint boilerplate code
5370
5471
EXAMPLES
55-
$ @vue-storefront/cli generate template
72+
$ @vue-storefront/cli add endpoint
5673
```
5774

58-
## `@vue-storefront/cli help [COMMAND]`
75+
_See code: [src/commands/add/endpoint.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/endpoint.ts)_
5976

60-
Display help for @vue-storefront/cli.
77+
## `@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]`
78+
79+
Generate integration boilerplate
6180

6281
```
6382
USAGE
64-
$ @vue-storefront/cli help [COMMAND] [-n]
65-
66-
ARGUMENTS
67-
COMMAND Command to show help for.
83+
$ @vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME] [-t nuxt|next]
6884
6985
FLAGS
70-
-n, --nested-commands Include all nested commands in the output.
86+
-t, --framework=<option> Framework to use
87+
<options: nuxt|next>
7188
7289
DESCRIPTION
73-
Display help for @vue-storefront/cli.
90+
Generate integration boilerplate
91+
92+
EXAMPLES
93+
$ @vue-storefront/cli create
7494
```
7595

76-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.16/src/commands/help.ts)_
96+
_See code: [src/commands/create/index.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/create/index.ts)_
97+
98+
## `@vue-storefront/cli create integration [NAME]`
7799

78-
## `@vue-storefront/cli init`
100+
Generate integration boilerplate
79101

80102
```
81103
USAGE
82-
$ @vue-storefront/cli init
104+
$ @vue-storefront/cli create integration [NAME] [-t nuxt|next]
105+
106+
FLAGS
107+
-t, --framework=<option> Framework to use
108+
<options: nuxt|next>
109+
110+
DESCRIPTION
111+
Generate integration boilerplate
83112
84113
EXAMPLES
85-
$ @vue-storefront/cli init
114+
$ @vue-storefront/cli create integration
115+
```
116+
117+
_See code: [src/commands/create/integration.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/create/integration.ts)_
118+
119+
## `@vue-storefront/cli help [COMMANDS]`
120+
121+
Display help for @vue-storefront/cli.
122+
86123
```
124+
USAGE
125+
$ @vue-storefront/cli help [COMMANDS] [-n]
126+
127+
ARGUMENTS
128+
COMMANDS Command to show help for.
87129
88-
_See code: [dist/commands/init.ts](https://github.com/vuestorefront/vue-storefront/blob/v3.0.0/dist/commands/init.ts)_
130+
FLAGS
131+
-n, --nested-commands Include all nested commands in the output.
132+
133+
DESCRIPTION
134+
Display help for @vue-storefront/cli.
135+
```
136+
137+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
89138

90139
## `@vue-storefront/cli plugins`
91140

@@ -105,7 +154,7 @@ EXAMPLES
105154
$ @vue-storefront/cli plugins
106155
```
107156

108-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.5/src/commands/plugins/index.ts)_
157+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
109158

110159
## `@vue-storefront/cli plugins:install PLUGIN...`
111160

@@ -160,13 +209,18 @@ FLAGS
160209
-h, --help Show CLI help.
161210
-v, --verbose
162211
212+
GLOBAL FLAGS
213+
--json Format output as json.
214+
163215
DESCRIPTION
164216
Displays installation properties of a plugin.
165217
166218
EXAMPLES
167219
$ @vue-storefront/cli plugins:inspect myplugin
168220
```
169221

222+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/inspect.ts)_
223+
170224
## `@vue-storefront/cli plugins:install PLUGIN...`
171225

172226
Installs a plugin into the CLI.
@@ -205,6 +259,8 @@ EXAMPLES
205259
$ @vue-storefront/cli plugins:install someuser/someplugin
206260
```
207261

262+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/install.ts)_
263+
208264
## `@vue-storefront/cli plugins:link PLUGIN`
209265

210266
Links a plugin into the CLI for development.
@@ -232,6 +288,8 @@ EXAMPLES
232288
$ @vue-storefront/cli plugins:link myplugin
233289
```
234290

291+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/link.ts)_
292+
235293
## `@vue-storefront/cli plugins:uninstall PLUGIN...`
236294

237295
Removes a plugin from the CLI.
@@ -278,6 +336,8 @@ ALIASES
278336
$ @vue-storefront/cli plugins remove
279337
```
280338

339+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/uninstall.ts)_
340+
281341
## `@vue-storefront/cli plugins:uninstall PLUGIN...`
282342

283343
Removes a plugin from the CLI.
@@ -317,6 +377,8 @@ DESCRIPTION
317377
Update installed plugins.
318378
```
319379

380+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/update.ts)_
381+
320382
## `@vue-storefront/cli update [CHANNEL]`
321383

322384
update the @vue-storefront/cli CLI
@@ -352,5 +414,5 @@ EXAMPLES
352414
$ @vue-storefront/cli update --available
353415
```
354416

355-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.0.4/src/commands/update.ts)_
417+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.2.4/src/commands/update.ts)_
356418
<!-- commandsstop -->

Diff for: ‎packages/cli/__tests__/domains/async/wait.spec.ts

-15
This file was deleted.

Diff for: ‎packages/cli/__tests__/domains/directory/existsDirectory.spec.ts

-22
This file was deleted.

Diff for: ‎packages/cli/__tests__/domains/directory/getDirectory.spec.ts

-64
This file was deleted.

Diff for: ‎packages/cli/__tests__/domains/directory/removeFileOrDirectory.spec.ts

-28
This file was deleted.

0 commit comments

Comments
 (0)