Skip to content

Commit

Permalink
docs(js): add a note to JS plugin overview that --preset=ts changed i…
Browse files Browse the repository at this point in the history
…n Nx 20, and that --preset=app can still be used
  • Loading branch information
jaysoo committed Oct 3, 2024
1 parent a0a5740 commit 1c29ddb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/generated/packages/js/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ yarn create nx-workspace my-org --preset=ts
{% /tab %}
{% /tabs %}

{% callout type="note" title="Modernized monorepo setup" %}
Nx 20 updates the TS monorepo setup when using `--preset=ts`. The workspace is set up with [TypeScript Project References](https://www.typescriptlang.org/docs/handbook/project-references.html) along with the Workspaces feature from [npm](https://docs.npmjs.com/cli/using-npm/workspaces), [yarn](https://yarnpkg.com/features/workspaces), [pnpm](https://pnpm.io/workspaces), and [bun](https://bun.sh/docs/install/workspaces).

To create with the older setup for TS monorepo with `compilerOptions.paths`, use `create-nx-workspace --preset=apps`.
{% /callout %}

## Create Libraries

You can add a new JS/TS library with the following command:
Expand Down
6 changes: 6 additions & 0 deletions docs/shared/packages/js/js-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ yarn create nx-workspace my-org --preset=ts
{% /tab %}
{% /tabs %}

{% callout type="note" title="Modernized monorepo setup" %}
Nx 20 updates the TS monorepo setup when using `--preset=ts`. The workspace is set up with [TypeScript Project References](https://www.typescriptlang.org/docs/handbook/project-references.html) along with the Workspaces feature from [npm](https://docs.npmjs.com/cli/using-npm/workspaces), [yarn](https://yarnpkg.com/features/workspaces), [pnpm](https://pnpm.io/workspaces), and [bun](https://bun.sh/docs/install/workspaces).

To create with the older setup for TS monorepo with `compilerOptions.paths`, use `create-nx-workspace --preset=apps`.
{% /callout %}

## Create Libraries

You can add a new JS/TS library with the following command:
Expand Down

0 comments on commit 1c29ddb

Please sign in to comment.