@nx/workspace 19.6.0-canary.20240809-d3747e0 → 19.6.0-canary.20240814-6d83ae2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/package.json +4 -4
  2. package/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__ +1 -2
  3. package/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__ +1 -2
  4. package/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__ +1 -2
  5. package/src/generators/ci-workflow/files/gitlab/.gitlab-ci.yml__tmpl__ +1 -2
  6. package/src/generators/new/files-readme/README.md.template +114 -50
  7. package/src/generators/new/generate-preset.js +1 -0
  8. package/src/generators/new/generate-workspace-files.js +134 -2
  9. package/src/generators/new/new.d.ts +1 -0
  10. package/src/generators/new/new.js +1 -1
  11. package/src/generators/preset/preset.js +13 -0
  12. package/src/generators/preset/schema.d.ts +1 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nx/workspace",
3
- "version": "19.6.0-canary.20240809-d3747e0",
3
+ "version": "19.6.0-canary.20240814-6d83ae2",
4
4
  "private": false,
5
5
  "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.",
6
6
  "repository": {
@@ -61,13 +61,13 @@
61
61
  }
62
62
  },
63
63
  "dependencies": {
64
- "@nx/devkit": "19.6.0-canary.20240809-d3747e0",
64
+ "@nx/devkit": "19.6.0-canary.20240814-6d83ae2",
65
65
  "chalk": "^4.1.0",
66
66
  "enquirer": "~2.3.6",
67
67
  "tslib": "^2.3.0",
68
68
  "yargs-parser": "21.1.1",
69
- "nx": "19.6.0-canary.20240809-d3747e0",
70
- "@nrwl/workspace": "19.6.0-canary.20240809-d3747e0"
69
+ "nx": "19.6.0-canary.20240814-6d83ae2",
70
+ "@nrwl/workspace": "19.6.0-canary.20240814-6d83ae2"
71
71
  },
72
72
  "publishConfig": {
73
73
  "access": "public"
package/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__ CHANGED
@@ -66,5 +66,4 @@ jobs:
66
66
  # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
67
67
  # - script: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
68
68
  # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
69
- - script: <%= packageManagerPrefix %> nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) lint test build<% if(hasE2E){ %>
70
- - script: <%= packageManagerPrefix %> nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) --parallel 1 e2e-ci<% } %>
69
+ - script: <%= packageManagerPrefix %> nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) lint test build<% if(hasE2E){ %> e2e-ci<% } %>
package/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__ CHANGED
@@ -35,8 +35,7 @@ jobs:
35
35
  # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
36
36
  # - run: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
37
37
  # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
38
- - run: <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD -t lint test build<% if(hasE2E){ %>
39
- - run: <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD --parallel 1 -t e2e-ci<% } %>
38
+ - run: <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD -t lint test build<% if(hasE2E){ %> e2e-ci<% } %>
40
39
 
41
40
  workflows:
42
41
  version: 2
package/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__ CHANGED
@@ -48,5 +48,4 @@ jobs:
48
48
  # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
49
49
  # - run: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
50
50
  # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
51
- - run: <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasE2E){ %>
52
- - run: <%= packageManagerPrefix %> nx affected --parallel 1 -t e2e-ci<% } %>
51
+ - run: <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasE2E){ %> e2e-ci<% } %>
package/src/generators/ci-workflow/files/gitlab/.gitlab-ci.yml__tmpl__ CHANGED
@@ -29,5 +29,4 @@ variables:
29
29
  # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
30
30
  # - <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
31
31
  # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
32
- - <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD -t lint test build<% if(hasE2E){ %>
33
- - <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD --parallel 1 -t e2e-ci<% } %>
32
+ - <%= packageManagerPrefix %> nx affected --base=$NX_BASE --head=$NX_HEAD -t lint test build<% if(hasE2E){ %> e2e-ci<% } %>
package/src/generators/new/files-readme/README.md.template CHANGED
@@ -2,88 +2,152 @@
2
2
 
3
3
  <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
4
4
 
5
- ✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨
6
-
7
- ## Integrate with editors
8
-
9
- Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console
10
- provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and
11
- comes with a LSP for Vim users.
12
- <% if (!!appName) {
13
- if (isJsStandalone) { %>
14
- ## Build the library
15
-
16
- Run `npx nx build` to build the library. The build artifacts are stored in the output directory (i.e. `dist/`), ready to be published.
5
+ ✨ Your new, shiny [Nx workspace](https://nx.dev) is <% if (nxCloudOnboardingUrl) { %>almost <% } %>ready ✨.
6
+ <% if (learnMoreLink) { %>
7
+ [Learn more about this workspace setup and its capabilities](<%= learnMoreLink %>) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
17
8
  <% } else { %>
18
- ## Start the application
9
+ Run `npx nx graph` to visually explore what got created. Now, let's get you up to speed!
10
+ <% } %><% if (nxCloudOnboardingUrl) { %>
11
+ ## Finish your <%= nxCloud === 'yes' ? 'remote caching' : 'CI' %> setup
19
12
 
20
- Run `npx nx <%= serveCommand %> <%= appName %>` to start the development server. Happy coding!
13
+ [Click here to finish setting up your workspace!](<%= nxCloudOnboardingUrl %>)
21
14
 
22
- ## Build for production
15
+ <% } %>
16
+ ## Run tasks
17
+ <% if (!isEmptyRepo) { %><% if (isJsStandalone) { %>
18
+ To build the library use:
23
19
 
24
- Run `npx nx build <%= appName %>` to build the application. The build artifacts are stored in the output directory (e.g. `dist/` or `build/`), ready to be deployed.
25
- <% } } else { %>
26
- ## Nx plugins and code generators
20
+ ```sh
21
+ npx nx build
22
+ ```
23
+ <% } else { %>
24
+ To run the dev server for your app, use:
25
+
26
+ ```sh
27
+ npx nx <%= serveCommand %> <%= appName %>
28
+ ```
27
29
 
28
- Add Nx plugins to leverage their code generators and automated, inferred tasks.
30
+ To create a production bundle:
29
31
 
32
+ ```sh
33
+ npx nx build <%= appName %>
30
34
  ```
31
- # Add plugin
32
- npx nx add @nx/react
33
35
 
34
- # Use code generator
35
- npx nx generate @nx/react:app demo
36
+ To see all available targets to run for a project, run:
36
37
 
37
- # Run development server
38
- npx nx serve demo
38
+ ```sh
39
+ npx nx show project <%= appName %>
40
+ ```
41
+ <% } %><% } else { %>
42
+ To run tasks with Nx use:
39
43
 
40
- # View project details
41
- npx nx show project demo --web
44
+ ```sh
45
+ npx nx <target> <project-name>
42
46
  ```
43
47
 
44
- Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list <plugin-name>` to see what generators are available.
48
+ For example:
45
49
 
46
- Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs.
50
+ ```sh
51
+ npx nx build myproject
52
+ ```
47
53
  <% } %>
48
- ## Running tasks
54
+ These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
55
+
56
+ [More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
57
+ <% if(isJsStandalone || generateNxReleaseInfo) { %>
58
+ ## Versioning and releasing
49
59
 
50
- To execute tasks with Nx use the following syntax:
60
+ To version and release the library use
51
61
 
52
62
  ```
53
- npx nx <target> <project> <...options>
63
+ npx nx release
54
64
  ```
55
65
 
56
- You can also run multiple targets:
66
+ Pass `--dry-run` to see what would happen without actually releasing the library.
57
67
 
58
- ```
59
- npx nx run-many -t <target1> <target2>
68
+ [Learn more about Nx release &raquo;](hhttps://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
69
+ <% } %><% if (!isJsStandalone) { %>
70
+ ## Add new projects
71
+
72
+ While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
73
+ <% if (isEmptyRepo) { %>
74
+ To install a new plugin you can use the `nx add` command. Here's an example of adding the React plugin:
75
+ ```sh
76
+ npx nx add @nx/react
60
77
  ```
61
78
 
62
- ..or add `-p` to filter specific projects
79
+ Use the plugin's generator to create new projects. For example, to create a new React app or library:
63
80
 
81
+ ```sh
82
+ # Genenerate an app
83
+ npx nx g @nx/react:app demo
84
+
85
+ # Generate a library
86
+ npx nx g @nx/react:lib some-lib
64
87
  ```
65
- npx nx run-many -t <target1> <target2> -p <proj1> <proj2>
88
+ <% } else { %>
89
+ Use the plugin's generator to create new projects.
90
+ <% if(generateAppCmd) {%>
91
+ To generate a new application, use:
92
+
93
+ ```sh
94
+ npx nx g <%= generateAppCmd%>:app demo
66
95
  ```
96
+ <% } %><% if(generateLibCmd) {%>
97
+ To generate a new library, use:
67
98
 
68
- Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
99
+ ```sh
100
+ npx nx g <%= generateLibCmd%>:lib mylib
101
+ ```
102
+ <% } %><% } %>
103
+ You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.
69
104
 
105
+ [Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
106
+ <% } %><% if (nxCloud === 'skip') { %>
70
107
  ## Set up CI!
71
108
 
72
- Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
109
+ ### Step 1
110
+
111
+ To connect to Nx Cloud, run the following command:
112
+
113
+ ```sh
114
+ npx nx connect
115
+ ```
116
+
117
+ Connecting to Nx Cloud ensures a [fast and scalable CI](https://nx.dev/ci/intro/why-nx-cloud?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) pipeline. It includes features such as:
118
+
119
+ - [Remote caching](https://nx.dev/ci/features/remote-cache?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
120
+ - [Task distribution across multiple machines](https://nx.dev/ci/features/distribute-task-execution?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
121
+ - [Automated e2e test splitting](https://nx.dev/ci/features/split-e2e-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
122
+ - [Task flakiness detection and rerunning](https://nx.dev/ci/features/flaky-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
123
+
124
+ ### Step 2
125
+
126
+ Use the following command to configure a CI workflow for your workspace:
127
+
128
+ ```sh
129
+ npx nx g ci-workflow
130
+ ```<% } %>
131
+
132
+ [Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
73
133
 
74
- - [Set up remote caching](https://nx.dev/features/share-your-cache)
75
- - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
76
- - [Learn more how to setup CI](https://nx.dev/recipes/ci)
134
+ ## Install Nx Console
77
135
 
78
- ## Explore the project graph
136
+ Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
79
137
 
80
- Run `npx nx graph` to show the graph of the workspace.
81
- It will show tasks that you can run with Nx.
138
+ [Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
82
139
 
83
- - [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph)
140
+ ## Useful links
84
141
 
85
- ## Connect with us!
142
+ Learn more:
143
+ <% if(learnMoreLink){ %>
144
+ - [Learn more about this workspace setup](<%= learnMoreLink %>)<% } %>
145
+ - [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
146
+ - [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
147
+ - [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
86
148
 
87
- - [Join the community](https://nx.dev/community)
88
- - [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
89
- - [Follow us on Twitter](https://twitter.com/nxdevtools)
149
+ And join the Nx community:
150
+ - [Discord](https://go.nx.dev/community)
151
+ - [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
152
+ - [Our Youtube channel](https://www.youtube.com/@nxdevtools)
153
+ - [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
package/src/generators/new/generate-preset.js CHANGED
@@ -68,6 +68,7 @@ function generatePreset(host, opts) {
68
68
  : null,
69
69
  opts.ssr ? `--ssr` : null,
70
70
  opts.prefix !== undefined ? `--prefix=${opts.prefix}` : null,
71
+ opts.nxCloudToken ? `--nxCloudToken=${opts.nxCloudToken}` : null,
71
72
  ].filter((e) => !!e);
72
73
  }
73
74
  }
package/src/generators/new/generate-workspace-files.js CHANGED
@@ -7,6 +7,123 @@ const path_1 = require("path");
7
7
  const presets_1 = require("../utils/presets");
8
8
  const default_base_1 = require("../../utilities/default-base");
9
9
  const connect_to_nx_cloud_1 = require("nx/src/nx-cloud/generators/connect-to-nx-cloud/connect-to-nx-cloud");
10
+ const url_shorten_1 = require("nx/src/nx-cloud/utilities/url-shorten");
11
+ // map from the preset to the name of the plugin s.t. the README can have a more
12
+ // meaningful generator command.
13
+ const presetToPluginMap = {
14
+ [presets_1.Preset.Apps]: {
15
+ learnMoreLink: 'https://nx.dev/getting-started/intro#learn-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
16
+ },
17
+ [presets_1.Preset.NPM]: {
18
+ generateNxReleaseInfo: true,
19
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/npm-workspaces-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
20
+ },
21
+ [presets_1.Preset.TS]: {
22
+ generateLibCmd: '@nx/js',
23
+ generateNxReleaseInfo: true,
24
+ learnMoreLink: 'https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
25
+ },
26
+ [presets_1.Preset.WebComponents]: {
27
+ generateAppCmd: null,
28
+ learnMoreLink: 'https://nx.dev/getting-started/intro#learn-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
29
+ },
30
+ [presets_1.Preset.AngularMonorepo]: {
31
+ generateAppCmd: '@nx/angular',
32
+ generateLibCmd: '@nx/angular',
33
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/angular-monorepo-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
34
+ },
35
+ [presets_1.Preset.AngularStandalone]: {
36
+ generateAppCmd: '@nx/angular',
37
+ generateLibCmd: '@nx/angular',
38
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/angular-standalone-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
39
+ },
40
+ [presets_1.Preset.ReactMonorepo]: {
41
+ generateAppCmd: '@nx/react',
42
+ generateLibCmd: '@nx/react',
43
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/react-monorepo-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
44
+ },
45
+ [presets_1.Preset.ReactStandalone]: {
46
+ generateAppCmd: '@nx/react',
47
+ generateLibCmd: '@nx/react',
48
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/react-standalone-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
49
+ },
50
+ [presets_1.Preset.NextJsStandalone]: {
51
+ generateAppCmd: '@nx/next',
52
+ generateLibCmd: '@nx/react',
53
+ learnMoreLink: 'https://nx.dev/nx-api/next?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
54
+ },
55
+ [presets_1.Preset.RemixMonorepo]: {
56
+ generateAppCmd: '@nx/remix',
57
+ generateLibCmd: '@nx/react',
58
+ learnMoreLink: 'https://nx.dev/nx-api/remix?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
59
+ },
60
+ [presets_1.Preset.RemixStandalone]: {
61
+ generateAppCmd: '@nx/remix',
62
+ generateLibCmd: '@nx/react',
63
+ learnMoreLink: 'https://nx.dev/nx-api/remix?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
64
+ },
65
+ [presets_1.Preset.ReactNative]: {
66
+ generateAppCmd: '@nx/react-native',
67
+ generateLibCmd: '@nx/react',
68
+ learnMoreLink: 'https://nx.dev/nx-api/react-native?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
69
+ },
70
+ [presets_1.Preset.VueMonorepo]: {
71
+ generateAppCmd: '@nx/vue',
72
+ generateLibCmd: '@nx/vue',
73
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/vue-standalone-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
74
+ },
75
+ [presets_1.Preset.VueStandalone]: {
76
+ generateAppCmd: '@nx/vue',
77
+ generateLibCmd: '@nx/vue',
78
+ learnMoreLink: 'https://nx.dev/getting-started/tutorials/vue-standalone-tutorial?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
79
+ },
80
+ [presets_1.Preset.Nuxt]: {
81
+ generateAppCmd: '@nx/nuxt',
82
+ generateLibCmd: '@nx/vue',
83
+ learnMoreLink: 'https://nx.dev/nx-api/nuxt?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
84
+ },
85
+ [presets_1.Preset.NuxtStandalone]: {
86
+ generateAppCmd: '@nx/nuxt',
87
+ generateLibCmd: '@nx/vue',
88
+ learnMoreLink: 'https://nx.dev/nx-api/nuxt?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
89
+ },
90
+ [presets_1.Preset.Expo]: {
91
+ generateAppCmd: '@nx/expo',
92
+ generateLibCmd: '@nx/react',
93
+ learnMoreLink: 'https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
94
+ },
95
+ [presets_1.Preset.NextJs]: {
96
+ generateAppCmd: '@nx/next',
97
+ generateLibCmd: '@nx/react',
98
+ learnMoreLink: 'https://nx.dev/nx-api/next?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
99
+ },
100
+ [presets_1.Preset.Nest]: {
101
+ generateAppCmd: '@nx/nest',
102
+ generateLibCmd: '@nx/node',
103
+ learnMoreLink: 'https://nx.dev/nx-api/nest?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
104
+ },
105
+ [presets_1.Preset.Express]: {
106
+ generateAppCmd: '@nx/express',
107
+ generateLibCmd: '@nx/node',
108
+ learnMoreLink: 'https://nx.dev/nx-api/express?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
109
+ },
110
+ [presets_1.Preset.NodeStandalone]: {
111
+ generateAppCmd: '@nx/node',
112
+ generateLibCmd: '@nx/node',
113
+ learnMoreLink: 'https://nx.dev/nx-api/node?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
114
+ },
115
+ [presets_1.Preset.NodeMonorepo]: {
116
+ generateAppCmd: '@nx/node',
117
+ generateLibCmd: '@nx/node',
118
+ learnMoreLink: 'https://nx.dev/nx-api/node?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
119
+ },
120
+ [presets_1.Preset.TsStandalone]: {
121
+ generateAppCmd: null,
122
+ generateLibCmd: null,
123
+ generateNxReleaseInfo: true,
124
+ learnMoreLink: 'https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
125
+ },
126
+ };
10
127
  async function generateWorkspaceFiles(tree, options) {
11
128
  if (!options.name) {
12
129
  throw new Error(`Invalid options, "name" is required.`);
@@ -15,7 +132,6 @@ async function generateWorkspaceFiles(tree, options) {
15
132
  // since it might influence the version report
16
133
  const packageManagerVersion = (0, devkit_1.getPackageManagerVersion)(options.packageManager, tree.root);
17
134
  options = normalizeOptions(options);
18
- createReadme(tree, options);
19
135
  createFiles(tree, options);
20
136
  const nxJson = createNxJson(tree, options);
21
137
  const token = options.nxCloud !== 'skip'
@@ -25,6 +141,7 @@ async function generateWorkspaceFiles(tree, options) {
25
141
  github: options.useGitHub,
26
142
  }, nxJson)
27
143
  : null;
144
+ await createReadme(tree, options, token);
28
145
  const [packageMajor] = packageManagerVersion.split('.');
29
146
  if (options.packageManager === 'pnpm' && +packageMajor >= 7) {
30
147
  createNpmrc(tree, options);
@@ -107,16 +224,31 @@ function createFiles(tree, options) {
107
224
  packageManager: options.packageManager,
108
225
  });
109
226
  }
110
- function createReadme(tree, { name, appName, directory, preset }) {
227
+ async function createReadme(tree, { name, appName, directory, preset, nxCloud }, nxCloudToken) {
111
228
  const formattedNames = (0, devkit_1.names)(name);
229
+ // default to an empty one for custom presets
230
+ const presetInfo = presetToPluginMap[preset] ?? {
231
+ package: '',
232
+ generateLibCmd: null,
233
+ };
234
+ const nxCloudOnboardingUrl = nxCloudToken
235
+ ? await (0, url_shorten_1.createNxCloudOnboardingURL)('readme', nxCloudToken)
236
+ : null;
112
237
  (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files-readme'), directory, {
113
238
  formattedNames,
114
239
  isJsStandalone: preset === presets_1.Preset.TsStandalone,
240
+ isEmptyRepo: !appName,
115
241
  appName,
242
+ generateAppCmd: presetInfo.generateAppCmd,
243
+ generateLibCmd: presetInfo.generateLibCmd,
244
+ generateNxReleaseInfo: presetInfo.generateNxReleaseInfo,
245
+ learnMoreLink: presetInfo.learnMoreLink,
116
246
  serveCommand: preset === presets_1.Preset.NextJs || preset === presets_1.Preset.NextJsStandalone
117
247
  ? 'dev'
118
248
  : 'serve',
119
249
  name,
250
+ nxCloud,
251
+ nxCloudOnboardingUrl,
120
252
  });
121
253
  }
122
254
  // ensure that pnpm install add all the missing peer deps
package/src/generators/new/new.d.ts CHANGED
@@ -27,6 +27,7 @@ interface Schema {
27
27
  export interface NormalizedSchema extends Schema {
28
28
  presetVersion?: string;
29
29
  isCustomPreset: boolean;
30
+ nxCloudToken?: string;
30
31
  }
31
32
  export declare function newGenerator(tree: Tree, opts: Schema): Promise<() => Promise<void>>;
32
33
  export default newGenerator;
package/src/generators/new/new.js CHANGED
@@ -10,7 +10,7 @@ const child_process_1 = require("child_process");
10
10
  async function newGenerator(tree, opts) {
11
11
  const options = normalizeOptions(opts);
12
12
  validateOptions(options, tree);
13
- await (0, generate_workspace_files_1.generateWorkspaceFiles)(tree, options);
13
+ options.nxCloudToken = await (0, generate_workspace_files_1.generateWorkspaceFiles)(tree, options);
14
14
  (0, generate_preset_1.addPresetDependencies)(tree, options);
15
15
  await (0, devkit_1.formatFiles)(tree);
16
16
  return async () => {
package/src/generators/preset/preset.js CHANGED
@@ -34,6 +34,7 @@ async function createPreset(tree, options) {
34
34
  bundler: options.bundler,
35
35
  ssr: options.ssr,
36
36
  prefix: options.prefix,
37
+ nxCloudToken: options.nxCloudToken,
37
38
  });
38
39
  }
39
40
  else if (options.preset === presets_1.Preset.AngularStandalone) {
@@ -51,6 +52,7 @@ async function createPreset(tree, options) {
51
52
  bundler: options.bundler,
52
53
  ssr: options.ssr,
53
54
  prefix: options.prefix,
55
+ nxCloudToken: options.nxCloudToken,
54
56
  });
55
57
  }
56
58
  else if (options.preset === presets_1.Preset.ReactMonorepo) {
@@ -65,6 +67,7 @@ async function createPreset(tree, options) {
65
67
  bundler: options.bundler ?? 'webpack',
66
68
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
67
69
  addPlugin,
70
+ nxCloudToken: options.nxCloudToken,
68
71
  });
69
72
  }
70
73
  else if (options.preset === presets_1.Preset.ReactStandalone) {
@@ -81,6 +84,7 @@ async function createPreset(tree, options) {
81
84
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
82
85
  unitTestRunner: options.bundler === 'vite' ? 'vitest' : 'jest',
83
86
  addPlugin,
87
+ nxCloudToken: options.nxCloudToken,
84
88
  });
85
89
  }
86
90
  else if (options.preset === presets_1.Preset.RemixMonorepo) {
@@ -94,6 +98,7 @@ async function createPreset(tree, options) {
94
98
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
95
99
  unitTestRunner: 'vitest',
96
100
  addPlugin,
101
+ nxCloudToken: options.nxCloudToken,
97
102
  });
98
103
  }
99
104
  else if (options.preset === presets_1.Preset.RemixStandalone) {
@@ -108,6 +113,7 @@ async function createPreset(tree, options) {
108
113
  rootProject: true,
109
114
  unitTestRunner: 'vitest',
110
115
  addPlugin,
116
+ nxCloudToken: options.nxCloudToken,
111
117
  });
112
118
  }
113
119
  else if (options.preset === presets_1.Preset.VueMonorepo) {
@@ -121,6 +127,7 @@ async function createPreset(tree, options) {
121
127
  linter: options.linter,
122
128
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
123
129
  addPlugin,
130
+ nxCloudToken: options.nxCloudToken,
124
131
  });
125
132
  }
126
133
  else if (options.preset === presets_1.Preset.VueStandalone) {
@@ -136,6 +143,7 @@ async function createPreset(tree, options) {
136
143
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
137
144
  unitTestRunner: 'vitest',
138
145
  addPlugin,
146
+ nxCloudToken: options.nxCloudToken,
139
147
  });
140
148
  }
141
149
  else if (options.preset === presets_1.Preset.Nuxt) {
@@ -149,6 +157,7 @@ async function createPreset(tree, options) {
149
157
  linter: options.linter,
150
158
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
151
159
  addPlugin,
160
+ nxCloudToken: options.nxCloudToken,
152
161
  });
153
162
  }
154
163
  else if (options.preset === presets_1.Preset.NuxtStandalone) {
@@ -164,6 +173,7 @@ async function createPreset(tree, options) {
164
173
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
165
174
  unitTestRunner: 'vitest',
166
175
  addPlugin,
176
+ nxCloudToken: options.nxCloudToken,
167
177
  });
168
178
  }
169
179
  else if (options.preset === presets_1.Preset.NextJs) {
@@ -209,6 +219,7 @@ async function createPreset(tree, options) {
209
219
  bundler: 'vite',
210
220
  e2eTestRunner: options.e2eTestRunner ?? 'playwright',
211
221
  addPlugin,
222
+ nxCloudToken: options.nxCloudToken,
212
223
  });
213
224
  }
214
225
  else if (options.preset === presets_1.Preset.Nest) {
@@ -244,6 +255,7 @@ async function createPreset(tree, options) {
244
255
  linter: options.linter,
245
256
  e2eTestRunner: options.e2eTestRunner ?? 'detox',
246
257
  addPlugin,
258
+ nxCloudToken: options.nxCloudToken,
247
259
  });
248
260
  }
249
261
  else if (options.preset === presets_1.Preset.Expo) {
@@ -255,6 +267,7 @@ async function createPreset(tree, options) {
255
267
  linter: options.linter,
256
268
  e2eTestRunner: options.e2eTestRunner ?? 'detox',
257
269
  addPlugin,
270
+ nxCloudToken: options.nxCloudToken,
258
271
  });
259
272
  }
260
273
  else if (options.preset === presets_1.Preset.TS) {
package/src/generators/preset/schema.d.ts CHANGED
@@ -19,4 +19,5 @@ export interface Schema {
19
19
  js?: boolean;
20
20
  ssr?: boolean;
21
21
  prefix?: string;
22
+ nxCloudToken?: string;
22
23
  }