Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(turbo/gen): mark as experimental #5016

Merged
merged 1 commit into from
May 18, 2023
+17 −13
Merged

chore(turbo/gen): mark as experimental #5016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/pages/repo/docs/core-concepts/monorepos/code-generation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: Extend your Turborepo with new apps, and packages. Create new empty
---

import Callout from "../../../../../components/Callout";
import Badge from "../../../../../components/Badge";

# Code Generation
# Code Generation <Badge>Experimental</Badge>

Splitting your monorepo into individual workspaces is a great way to organize your code, speed up tasks, and improve the local development
experience. With Turborepo's code generation, it's easy to generate new source code for packages, modules,
Expand Down
27 changes: 15 additions & 12 deletions docs/pages/repo/docs/reference/command-line-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Task details include:

`type: string`

<Callout type="info">
<Callout>
**Warning**: This is an experimental flag, so its name and behavior can change.
</Callout>

Expand Down Expand Up @@ -707,9 +707,13 @@ Get the path to the `turbo` binary.

## `turbo gen`

<Callout>
**Warning**: This is an experimental command, so its name and behavior can change.
</Callout>

Extend your Turborepo with new apps, and packages. Create new empty workspaces, copy existing workspaces, add workspaces from remote sources or run custom generators defined using Plop configurations.

**Note:** The default command for generate is [run](#run-generator-name).
**Note:** The default command for `generate` is [run](#run-generator-name).

### `workspace`

Expand All @@ -723,7 +727,7 @@ The name for the new workspace

##### `--empty`

Generate an empty workspace
Generate an empty workspace (default: `true`)

##### `--copy`

Expand All @@ -735,25 +739,24 @@ Where the new workspace should be created

##### `--type`

The type of workspace to create ("app" or "package")
The type of workspace to create (`app` or `package`)

##### `--root`

The root of your repository (default: directory with _root_ turbo.json)
The root of your repository (default: directory with _root_ `turbo.json`)

##### `--example / -e`

An example package to add. You can use a GitHub URL with any branch and/or subdirectory

##### `--example-path`
##### `--example-path / -p`

In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar).
In this case, you must specify the path to
the example separately: `--example-path foo/bar`
In a rare case, your GitHub URL might contain a branch name with a slash (e.g. `bug/fix-1`) and the path to the example (e.g. `foo/bar`).
In this case, you must specify the path to the example separately: `--example-path foo/bar`

##### `--show-all-dependencies`

When selecting dependencies to add to your new workspace, do not filter available dependencies by the selected workspace type ("app" or "package")
When selecting dependencies to add to your new workspace, do not filter available dependencies by the selected workspace type (`app` or `package`)

### `run [generator-name]`

Expand All @@ -763,11 +766,11 @@ Run custom generators within your monorepo. Optionally specify a generator name

##### `--config`

Generator configuration file (default: turbo/generators/config.js)
Generator configuration file (default: `turbo/generators/config.js`)

##### `--root`

The root of your repository (default: directory with _root_ turbo.json)
The root of your repository (default: directory with _root_ `turbo.json`)

##### `--args`

Expand Down