feat(core): make nx.json optional

nrwl · May 31, 2022 · e491c6f · e491c6f · vercel · May 31, 2022
1 parent b35e383
commit e491c6f
Show file tree

Hide file tree

Showing 156 changed files with 711 additions and 1,479 deletions.
diff --git a/dep-graph/client/project.json b/dep-graph/client/project.json
@@ -89,7 +89,7 @@
       }
     },
     "serve": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "outputs": [],
       "options": {
         "commands": [
@@ -113,7 +113,7 @@
       }
     },
     "serve-for-e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "outputs": [],
       "options": {
         "commands": [

diff --git a/docs/generated/cli/init.md b/docs/generated/cli/init.md
@@ -0,0 +1,16 @@
+---
+title: 'init - CLI command'
+description: 'Adds nx.json file and installs nx if not installed already'
+---
+
+# init
+
+Adds nx.json file and installs nx if not installed already
+
+## Usage
+
+```bash
+nx init
+```
+
+[Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.
diff --git a/docs/generated/devkit/index.md b/docs/generated/devkit/index.md
@@ -76,12 +76,12 @@ It only uses language primitives and immutable objects
 - [NxAffectedConfig](../../devkit/index#nxaffectedconfig)
 - [NxJsonConfiguration](../../devkit/index#nxjsonconfiguration)
 - [ProjectConfiguration](../../devkit/index#projectconfiguration)
+- [ProjectsConfigurations](../../devkit/index#projectsconfigurations)
 - [TargetConfiguration](../../devkit/index#targetconfiguration)
 - [TargetDependencyConfig](../../devkit/index#targetdependencyconfig)
 - [Task](../../devkit/index#task)
 - [TaskGraph](../../devkit/index#taskgraph)
 - [Workspace](../../devkit/index#workspace)
-- [WorkspaceJsonConfiguration](../../devkit/index#workspacejsonconfiguration)
 
 ### Generators Type aliases
 
@@ -112,6 +112,7 @@ It only uses language primitives and immutable objects
 - [ImplicitDependencyEntry](../../devkit/index#implicitdependencyentry)
 - [ProjectType](../../devkit/index#projecttype)
 - [TaskGraphExecutor](../../devkit/index#taskgraphexecutor)
+- [WorkspaceJsonConfiguration](../../devkit/index#workspacejsonconfiguration)
 
 ### Logger Variables
 
@@ -151,6 +152,7 @@ It only uses language primitives and immutable objects
 - [offsetFromRoot](../../devkit/index#offsetfromroot)
 - [parseJson](../../devkit/index#parsejson)
 - [parseTargetString](../../devkit/index#parsetargetstring)
+- [readAllWorkspaceConfiguration](../../devkit/index#readallworkspaceconfiguration)
 - [readCachedProjectGraph](../../devkit/index#readcachedprojectgraph)
 - [readJson](../../devkit/index#readjson)
 - [readJsonFile](../../devkit/index#readjsonfile)
@@ -424,6 +426,12 @@ A plugin for Nx
 
 ---
 
+### ProjectsConfigurations
+
+• **ProjectsConfigurations**: `Object`
+
+---
+
 ### TargetConfiguration
 
 • **TargetConfiguration**: `Object`
@@ -452,17 +460,11 @@ A plugin for Nx
 
 • **Workspace**: `Object`
 
----
-
-### WorkspaceJsonConfiguration
-
-• **WorkspaceJsonConfiguration**: `Object`
-
 ## Generators Type aliases
 
 ### WorkspaceConfiguration
 
-Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)\>
+Ƭ **WorkspaceConfiguration**: `Omit`<[`ProjectsConfigurations`](../../devkit/index#projectsconfigurations), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)\>
 
 ---
 
@@ -666,6 +668,12 @@ Implementation of a target of a project that handles multiple projects to be bat
 
 `Promise`<`Record`<`string`, `Object`\>\>
 
+---
+
+### WorkspaceJsonConfiguration
+
+Ƭ **WorkspaceJsonConfiguration**: [`ProjectsConfigurations`](../../devkit/index#projectsconfigurations)
+
 ## Logger Variables
 
 ### logger
@@ -689,7 +697,7 @@ Implementation of a target of a project that handles multiple projects to be bat
 
 ### appRootPath
 
-• **appRootPath**: `string`
+• **appRootPath**: `string` = `workspaceRoot`
 
 ---
 
@@ -707,7 +715,7 @@ Implementation of a target of a project that handles multiple projects to be bat
 
 ### workspaceRoot
 
-• **workspaceRoot**: `string` = `appRootPath`
+• **workspaceRoot**: `string`
 
 ## Functions
 
@@ -1357,6 +1365,16 @@ parseTargetString('proj:test:production'); // returns { project: "proj", target:
 
 ---
 
+### readAllWorkspaceConfiguration
+
+▸ **readAllWorkspaceConfiguration**(): [`ProjectsConfigurations`](../../devkit/index#projectsconfigurations) & [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
+
+#### Returns
+
+[`ProjectsConfigurations`](../../devkit/index#projectsconfigurations) & [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
+
+---
+
 ### readCachedProjectGraph
 
 ▸ **readCachedProjectGraph**(): [`ProjectGraph`](../../devkit/index#projectgraph)
@@ -1426,17 +1444,7 @@ Object the JSON content of the file represents
 
 ### readNxJson
 
-▸ **readNxJson**(`path?`): [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
-
-Returns the contents of nx.json.
-
-If nx.json extends another config file, it will be inlined here.
-
-#### Parameters
-
-| Name   | Type     |
-| :----- | :------- |
-| `path` | `string` |
+▸ **readNxJson**(): [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
 
 #### Returns
 

diff --git a/docs/generated/packages/cli.json b/docs/generated/packages/cli.json
@@ -11,6 +11,12 @@
       "file": "generated/cli/create-nx-workspace",
       "content": "---\ntitle: 'create-nx-workspace - CLI command'\ndescription: 'Create a new Nx workspace'\n---\n\n# create-nx-workspace\n\nCreate a new Nx workspace\n\n## Usage\n\n```bash\ncreate-nx-workspace [name] [options]\n```\n\nInstall `create-nx-workspace` globally to invoke the command directly, or use `npx create-nx-workspace`, `yarn create nx-workspace`, or `pnpx create-nx-workspace`.\n\n## Options\n\n### allPrompts\n\nType: boolean\n\nDefault: false\n\nShow all prompts\n\n### appName\n\nType: string\n\nThe name of the application when a preset with pregenerated app is selected\n\n### ci\n\nType: string\n\nChoices: [github, circleci, azure]\n\nGenerate a CI workflow file\n\n### cli\n\nType: string\n\nChoices: [nx, angular]\n\nCLI to power the Nx workspace\n\n### defaultBase\n\nType: string\n\nDefault: main\n\nDefault base to use for new projects\n\n### help\n\nType: boolean\n\nShow help\n\n### interactive\n\nType: boolean\n\nEnable interactive mode with presets\n\n### name\n\nType: string\n\nWorkspace name (e.g. org name)\n\n### nxCloud\n\nType: boolean\n\nUse Nx Cloud\n\n### packageManager\n\nType: string\n\nChoices: [npm, pnpm, yarn]\n\nDefault: npm\n\nPackage manager to use\n\n### preset\n\nType: string\n\nCustomizes the initial content of your workspace. Default presets include: [\"apps\", \"empty\", \"core\", \"npm\", \"ts\", \"web-components\", \"angular\", \"angular-nest\", \"react\", \"react-express\", \"react-native\", \"next\", \"nest\", \"express\"]. To build your own see https://nx.dev/packages/nx-plugin#preset\n\n### style\n\nType: string\n\nStyle option to be used when a preset with pregenerated app is selected\n\n### version\n\nType: boolean\n\nShow version number\n"
     },
+    {
+      "name": "init",
+      "id": "init",
+      "file": "generated/cli/init",
+      "content": "---\ntitle: 'init - CLI command'\ndescription: 'Adds nx.json file and installs nx if not installed already'\n---\n\n# init\n\nAdds nx.json file and installs nx if not installed already\n\n## Usage\n\n```bash\nnx init\n```\n\n[Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.\n"
+    },
     {
       "name": "generate",
       "id": "generate",

diff --git a/docs/generated/packages/devkit.json b/docs/generated/packages/devkit.json
diff --git a/docs/map.json b/docs/map.json
@@ -870,6 +870,7 @@
             "id": "create-nx-workspace",
             "file": "generated/cli/create-nx-workspace"
           },
+          { "name": "init", "id": "init", "file": "generated/cli/init" },
           {
             "name": "generate",
             "id": "generate",

diff --git a/docs/shared/nx-core.md b/docs/shared/nx-core.md
@@ -42,7 +42,6 @@ package.json
 ```json
 {
   "extends": "nx/presets/core.json",
-  "npmScope": "myorg",
   "tasksRunnerOptions": {
     "default": {
       "runner": "nx/tasks-runners/default",

diff --git a/e2e/add-nx-to-monorepo/project.json b/e2e/add-nx-to-monorepo/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/add-nx-to-monorepo/src/add-nx-to-monorepo.test.ts b/e2e/add-nx-to-monorepo/src/add-nx-to-monorepo.test.ts
@@ -23,12 +23,20 @@ describe('add-nx-to-monorepo', () => {
         'packages/package-a/package.json',
         JSON.stringify({
           name: 'package-a',
+          scripts: {
+            serve: 'some serve',
+            build: 'some build',
+            test: 'some test',
+          },
         })
       );
       updateFile(
         'packages/package-b/package.json',
         JSON.stringify({
           name: 'package-b',
+          scripts: {
+            lint: 'some lint',
+          },
         })
       );
 
@@ -40,6 +48,13 @@ describe('add-nx-to-monorepo', () => {
       expect(output).toContain('🎉 Done!');
       expect(readWorkspaceConfig().projects['package-a']).toBeTruthy();
       expect(readWorkspaceConfig().projects['package-b']).toBeTruthy();
+      expect(readWorkspaceConfig().targetDependencies).toEqual({
+        build: [{ projects: 'dependencies', target: 'build' }],
+      });
+      expect(
+        readWorkspaceConfig().tasksRunnerOptions['default'].options
+          .cacheableOperations
+      ).toEqual(['build', 'test', 'lint']);
     }
   });
 

diff --git a/e2e/angular-core/project.json b/e2e/angular-core/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/angular-extensions/project.json b/e2e/angular-extensions/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/cli/project.json b/e2e/cli/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/cypress/project.json b/e2e/cypress/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/detox/project.json b/e2e/detox/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/jest/project.json b/e2e/jest/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/js/project.json b/e2e/js/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/linter/project.json b/e2e/linter/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/next/project.json b/e2e/next/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/node/project.json b/e2e/node/project.json
@@ -4,7 +4,7 @@
   "projectType": "application",
   "targets": {
     "e2e": {
-      "executor": "@nrwl/workspace:run-commands",
+      "executor": "nx:run-commands",
       "options": {
         "commands": [
           {

diff --git a/e2e/nx-init/jest.config.ts b/e2e/nx-init/jest.config.ts
@@ -0,0 +1,10 @@
+export default {
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
+  maxWorkers: 1,
+  globals: { 'ts-jest': { tsconfig: '<rootDir>/tsconfig.spec.json' } },
+  displayName: 'e2e-nx-init',
+  preset: '../../jest.preset.js',
+};
diff --git a/e2e/nx-init/project.json b/e2e/nx-init/project.json
@@ -0,0 +1,34 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "e2e/nx-init",
+  "projectType": "application",
+  "targets": {
+    "e2e": {
+      "executor": "nx:run-commands",
+      "options": {
+        "commands": [
+          {
+            "command": "yarn e2e-start-local-registry"
+          },
+          {
+            "command": "yarn e2e-build-package-publish"
+          },
+          {
+            "command": "nx run-e2e-tests e2e-nx-init"
+          }
+        ],
+        "parallel": false
+      }
+    },
+    "run-e2e-tests": {
+      "executor": "@nrwl/jest:jest",
+      "options": {
+        "jestConfig": "e2e/nx-init/jest.config.ts",
+        "passWithNoTests": true,
+        "runInBand": true
+      },
+      "outputs": ["coverage/e2e/nx-init"]
+    }
+  },
+  "implicitDependencies": ["nx"]
+}