feat!: remove generate command from cli

vuestorefront · Dec 11, 2024 · 62fbd74 · 62fbd74
1 parent ca1bf1a
commit 62fbd74
Show file tree

Hide file tree

Showing 85 changed files with 95 additions and 2,828 deletions.
diff --git a/.changeset/shaggy-turtles-ring.md b/.changeset/shaggy-turtles-ring.md
@@ -0,0 +1,5 @@
+---
+"@vue-storefront/cli": major
+---
+
+**[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 --git a/packages/cli/README.md b/packages/cli/README.md
@@ -17,10 +17,11 @@ npx @vue-storefront/cli generate template
 ## Commands
 
 <!-- commands -->
-* [`@vue-storefront/cli generate store`](#vue-storefrontcli-generate-store)
-* [`@vue-storefront/cli generate template`](#vue-storefrontcli-generate-template)
-* [`@vue-storefront/cli help [COMMAND]`](#vue-storefrontcli-help-command)
-* [`@vue-storefront/cli init`](#vue-storefrontcli-init)
+* [`@vue-storefront/cli add [COMMANDARG] [ENDPOINT]`](#vue-storefrontcli-add-commandarg-endpoint)
+* [`@vue-storefront/cli add endpoint [NAME]`](#vue-storefrontcli-add-endpoint-name)
+* [`@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]`](#vue-storefrontcli-create-commandname-integrationname)
+* [`@vue-storefront/cli create integration [NAME]`](#vue-storefrontcli-create-integration-name)
+* [`@vue-storefront/cli help [COMMANDS]`](#vue-storefrontcli-help-commands)
 * [`@vue-storefront/cli plugins`](#vue-storefrontcli-plugins)
 * [`@vue-storefront/cli plugins:install PLUGIN...`](#vue-storefrontcli-pluginsinstall-plugin)
 * [`@vue-storefront/cli plugins:inspect PLUGIN...`](#vue-storefrontcli-pluginsinspect-plugin)
@@ -32,60 +33,108 @@ npx @vue-storefront/cli generate template
 * [`@vue-storefront/cli plugins update`](#vue-storefrontcli-plugins-update)
 * [`@vue-storefront/cli update [CHANNEL]`](#vue-storefrontcli-update-channel)
 
-## `@vue-storefront/cli generate store`
+## `@vue-storefront/cli add [COMMANDARG] [ENDPOINT]`
+
+Create new endpoint boilerplate code
 
 ```
 USAGE
-  $ @vue-storefront/cli generate store
+  $ @vue-storefront/cli add [COMMANDARG] [ENDPOINT]
+
+ARGUMENTS
+  COMMANDARG  Name of the command
+  ENDPOINT    Name of the endpoint
+
+DESCRIPTION
+  Create new endpoint boilerplate code
 
 EXAMPLES
-  $ @vue-storefront/cli generate store
+  $ @vue-storefront/cli add <command> <endpoint>
 ```
 
-## `@vue-storefront/cli generate template`
+_See code: [src/commands/add/index.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/index.ts)_
+
+## `@vue-storefront/cli add endpoint [NAME]`
+
+Create new endpoint boilerplate code
 
 ```
 USAGE
-  $ @vue-storefront/cli generate template [--output <value>]
+  $ @vue-storefront/cli add endpoint [NAME]
 
-FLAGS
-  --output=<value>  [default: .]
+ARGUMENTS
+  NAME  Name of the endpoint
+
+DESCRIPTION
+  Create new endpoint boilerplate code
 
 EXAMPLES
-  $ @vue-storefront/cli generate template
+  $ @vue-storefront/cli add endpoint
 ```
 
-## `@vue-storefront/cli help [COMMAND]`
+_See code: [src/commands/add/endpoint.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/endpoint.ts)_
 
-Display help for @vue-storefront/cli.
+## `@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]`
+
+Generate integration boilerplate
 
 ```
 USAGE
-  $ @vue-storefront/cli help [COMMAND] [-n]
-
-ARGUMENTS
-  COMMAND  Command to show help for.
+  $ @vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME] [-t nuxt|next]
 
 FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
+  -t, --framework=<option>  Framework to use
+                            <options: nuxt|next>
 
 DESCRIPTION
-  Display help for @vue-storefront/cli.
+  Generate integration boilerplate
+
+EXAMPLES
+  $ @vue-storefront/cli create
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.16/src/commands/help.ts)_
+_See code: [src/commands/create/index.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/create/index.ts)_
+
+## `@vue-storefront/cli create integration [NAME]`
 
-## `@vue-storefront/cli init`
+Generate integration boilerplate
 
 ```
 USAGE
-  $ @vue-storefront/cli init
+  $ @vue-storefront/cli create integration [NAME] [-t nuxt|next]
+
+FLAGS
+  -t, --framework=<option>  Framework to use
+                            <options: nuxt|next>
+
+DESCRIPTION
+  Generate integration boilerplate
 
 EXAMPLES
-  $ @vue-storefront/cli init
+  $ @vue-storefront/cli create integration
+```
+
+_See code: [src/commands/create/integration.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/create/integration.ts)_
+
+## `@vue-storefront/cli help [COMMANDS]`
+
+Display help for @vue-storefront/cli.
+
 ```
+USAGE
+  $ @vue-storefront/cli help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
 
-_See code: [dist/commands/init.ts](https://github.com/vuestorefront/vue-storefront/blob/v3.0.0/dist/commands/init.ts)_
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for @vue-storefront/cli.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
 
 ## `@vue-storefront/cli plugins`
 
@@ -105,7 +154,7 @@ EXAMPLES
   $ @vue-storefront/cli plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.5/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
 
 ## `@vue-storefront/cli plugins:install PLUGIN...`
 
@@ -160,13 +209,18 @@ FLAGS
   -h, --help     Show CLI help.
   -v, --verbose
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   Displays installation properties of a plugin.
 
 EXAMPLES
   $ @vue-storefront/cli plugins:inspect myplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/inspect.ts)_
+
 ## `@vue-storefront/cli plugins:install PLUGIN...`
 
 Installs a plugin into the CLI.
@@ -205,6 +259,8 @@ EXAMPLES
   $ @vue-storefront/cli plugins:install someuser/someplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/install.ts)_
+
 ## `@vue-storefront/cli plugins:link PLUGIN`
 
 Links a plugin into the CLI for development.
@@ -232,6 +288,8 @@ EXAMPLES
   $ @vue-storefront/cli plugins:link myplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/link.ts)_
+
 ## `@vue-storefront/cli plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
@@ -278,6 +336,8 @@ ALIASES
   $ @vue-storefront/cli plugins remove
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/uninstall.ts)_
+
 ## `@vue-storefront/cli plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
@@ -317,6 +377,8 @@ DESCRIPTION
   Update installed plugins.
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/update.ts)_
+
 ## `@vue-storefront/cli update [CHANNEL]`
 
 update the @vue-storefront/cli CLI
@@ -352,5 +414,5 @@ EXAMPLES
     $ @vue-storefront/cli update --available
 ```
 
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.0.4/src/commands/update.ts)_
+_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.2.4/src/commands/update.ts)_
 <!-- commandsstop -->
diff --git a/packages/cli/__tests__/domains/async/wait.spec.ts b/packages/cli/__tests__/domains/async/wait.spec.ts
diff --git a/packages/cli/__tests__/domains/directory/existsDirectory.spec.ts b/packages/cli/__tests__/domains/directory/existsDirectory.spec.ts
diff --git a/packages/cli/__tests__/domains/directory/getDirectory.spec.ts b/packages/cli/__tests__/domains/directory/getDirectory.spec.ts
diff --git a/packages/cli/__tests__/domains/directory/removeFileOrDirectory.spec.ts b/packages/cli/__tests__/domains/directory/removeFileOrDirectory.spec.ts