feat: Support Nx 17+ (#72)

NathanWalker · web-flow · commit 5019eba3cbbb · 2023-10-22T18:08:07.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -38,3 +38,5 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+
+.nx/cache
diff --git a/.prettierignore b/.prettierignore
@@ -2,3 +2,5 @@
 
 /dist
 /coverage
+
+/.nx/cache
diff --git a/migrations.json b/migrations.json
diff --git a/nx.json b/nx.json
@@ -1,17 +1,7 @@
 {
-  "npmScope": "nativescript",
   "affected": {
     "defaultBase": "master"
   },
-  "tasksRunnerOptions": {
-    "default": {
-      "runner": "nx/tasks-runners/default",
-      "options": {
-        "cacheableOperations": ["build", "lint", "test", "e2e"],
-        "parallel": 1
-      }
-    }
-  },
   "workspaceLayout": {
     "appsDir": "e2e",
     "libsDir": "packages"
@@ -20,15 +10,24 @@
   "targetDefaults": {
     "build": {
       "dependsOn": ["^build"],
-      "inputs": ["production", "^production"]
+      "inputs": ["production", "^production"],
+      "cache": true
     },
     "test": {
-      "inputs": ["default", "^production", "{workspaceRoot}/jest.preset.js"]
+      "inputs": ["default", "^production", "{workspaceRoot}/jest.preset.js"],
+      "cache": true
+    },
+    "lint": {
+      "cache": true
+    },
+    "e2e": {
+      "cache": true
     }
   },
   "namedInputs": {
     "default": ["{projectRoot}/**/*", "sharedGlobals"],
     "sharedGlobals": ["{workspaceRoot}/workspace.json", "{workspaceRoot}/tsconfig.base.json", "{workspaceRoot}/tslint.json", "{workspaceRoot}/nx.json"],
     "production": ["default", "!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)", "!{projectRoot}/tsconfig.spec.json", "!{projectRoot}/jest.config.[jt]s", "!{projectRoot}/src/test-setup.[jt]s"]
-  }
+  },
+  "parallel": 1
 }
diff --git a/package.json b/package.json
@@ -31,44 +31,44 @@
   },
   "private": true,
   "devDependencies": {
-    "@angular-devkit/schematics": "16.1.3",
-    "@angular/core": "16.1.3",
-    "@swc-node/register": "^1.4.2",
-    "@swc/core": "^1.2.173",
-    "@types/fs-extra": "^9.0.11",
-    "@types/jest": "29.5.2",
-    "@types/node": "^18.0.0",
+    "@angular-devkit/schematics": "16.2.7",
+    "@angular/core": "16.2.10",
+    "@swc-node/register": "1.6.8",
+    "@swc/core": "1.3.94",
+    "@types/fs-extra": "^11.0.3",
+    "@types/jest": "29.5.6",
+    "@types/node": "^20.0.0",
     "@types/plist": "^3.0.2",
     "@types/xml2js": "^0.4.9",
-    "@typescript-eslint/eslint-plugin": "5.61.0",
-    "@typescript-eslint/parser": "5.61.0",
-    "conventional-changelog-cli": "^2.1.1",
+    "@typescript-eslint/eslint-plugin": "~6.8.0",
+    "@typescript-eslint/parser": "~6.8.0",
+    "conventional-changelog-cli": "^4.1.0",
     "cz-conventional-changelog": "^3.3.0",
     "doctoc": "^2.0.0",
-    "dotenv": "10.0.0",
-    "eslint": "7.22.0",
-    "eslint-config-prettier": "8.1.0",
+    "dotenv": "~16.3.1",
+    "eslint": "8.46.0",
+    "eslint-config-prettier": "9.0.0",
     "fs-extra": "^11.1.0",
     "jest": "29.6.0",
-    "jsonc-parser": "3.0.0",
-    "nx": "16.5.0",
-    "plist": "^3.0.4",
+    "jsonc-parser": "3.2.0",
+    "nx": "17.0.1",
+    "plist": "^3.1.0",
     "prettier": "^2.7.0",
     "ts-jest": "29.1.1",
     "ts-node": "10.9.1",
-    "tslib": "^2.4.0",
-    "typescript": "5.1.6",
-    "xml2js": "^0.4.23",
-    "nx-cloud": "16.0.5",
-    "@nx/devkit": "16.5.0",
-    "@nx/workspace": "16.5.0",
-    "@nx/plugin": "16.5.0",
-    "@nx/web": "16.5.0",
-    "@nx/js": "16.5.0",
-    "@nx/eslint-plugin": "16.5.0",
-    "@nx/jest": "16.5.0",
-    "@nx/linter": "16.5.0",
-    "@nx/express": "16.5.0",
-    "@nx/angular": "16.5.0"
+    "tslib": "^2.6.2",
+    "typescript": "~5.2.0",
+    "xml2js": "^0.6.2",
+    "nx-cloud": "16.5.2",
+    "@nx/devkit": "17.0.1",
+    "@nx/workspace": "17.0.1",
+    "@nx/plugin": "17.0.1",
+    "@nx/web": "17.0.1",
+    "@nx/js": "17.0.1",
+    "@nx/eslint-plugin": "17.0.1",
+    "@nx/jest": "17.0.1",
+    "@nx/express": "17.0.1",
+    "@nx/angular": "17.0.1",
+    "@nx/eslint": "17.0.1"
   }
 }
diff --git a/packages/nx/README.md b/packages/nx/README.md
@@ -9,7 +9,7 @@
 
 </div>
 
-> Requires at least NativeScript CLI v8.x.x or higher. You can confirm your CLI version by running `ns --version`.
+> Requires at least NativeScript CLI v8.x.x or higher. You can confirm your CLI version by running `ns -v`.
 
 ## Table of Contents
 
@@ -64,23 +64,13 @@ None:          Configures a minimal structure without specific frameworks or tec
 
 # Choose "Integrated"
 
-? Package-based or integrated? … 
-Integrated:    Nx creates a workspace structure most suitable for building apps.
+? Package-based monorepo, integrated monorepo, or standalone project?
+Integrated Monorepo:        Nx creates a monorepo that contains multiple projects.
 ```
 
 ### Init workspace
 
-Install the @nx/js plugin.
-
-```sh
-# Using npm
-npm install --save-dev @nx/js
-
-# Using yarn
-yarn add -D @nx/js
-```
-
-Now initialize -- This will ensure a `tsconfig.base.json` is created to begin building your workspace.
+Initialize a TypeScript project -- This will ensure a `tsconfig.base.json` is created to begin building your workspace.
 
 ```sh
 npx nx g @nx/js:init
diff --git a/packages/nx/package.json b/packages/nx/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nativescript/nx",
-  "version": "16.6.0",
+  "version": "17.0.0",
   "description": "NativeScript Plugin for Nx",
   "repository": {
     "type": "git",
@@ -33,10 +33,10 @@
     "@angular-devkit/schematics": "^16.0.0",
     "fs-extra": "^11.1.0",
     "ignore": "^5.2.4",
-    "plist": "^3.0.1",
+    "plist": "^3.1.0",
     "xml2js": "~0.6.0",
-    "@nx/devkit": "^16.0.0",
-    "@nx/js": "^16.0.0",
-    "@nx/jest": "^16.0.0"
+    "@nx/devkit": "^17.0.0",
+    "@nx/js": "^17.0.0",
+    "@nx/jest": "^17.0.0"
   }
 }
diff --git a/packages/nx/project.json b/packages/nx/project.json
@@ -6,7 +6,7 @@
   "generators": {},
   "targets": {
     "lint": {
-      "executor": "@nx/linter:eslint",
+      "executor": "@nx/eslint:lint",
       "outputs": ["{options.outputFile}"],
       "options": {
         "lintFilePatterns": ["packages/nx/**/*.ts"]
@@ -56,7 +56,8 @@
             "glob": "migrations.json",
             "output": "."
           }
-        ]
+        ],
+        "updateBuildableProjectDepsInPackageJson": true
       }
     }
   },
diff --git a/packages/nx/src/generators/app-resources/app-resources.ts b/packages/nx/src/generators/app-resources/app-resources.ts
@@ -5,7 +5,7 @@ import { Schema as AppResourcesSchema } from './schema';
 
 export function appResources(tree: Tree, options: AppResourcesSchema) {
   generateFiles(tree, joinPathFragments(__dirname, 'files'), options.path, {
-    ...getDefaultTemplateOptions(),
+    ...getDefaultTemplateOptions(tree),
     name: options.name || 'App_Resources',
     libFolderName: PluginHelpers.getLibFoldername('nativescript'),
   });
diff --git a/packages/nx/src/generators/application/application.ts b/packages/nx/src/generators/application/application.ts
@@ -99,7 +99,7 @@ export async function applicationGenerator(tree: Tree, options: Schema) {
         },
       },
       lint: {
-        executor: '@nx/linter:eslint',
+        executor: '@nx/eslint:eslint',
         options: {
           lintFilePatterns: [`${appPath}/**/*.ts`, `${appPath}/src/**/*.html`],
         },
@@ -122,7 +122,7 @@ function addAppFiles(tree: Tree, options: Schema, appName: string, extra: string
   }
   generateFiles(tree, joinPathFragments(__dirname, `files${framework ? '_' + framework : ''}${extra ? '_' + extra : ''}`), `apps/${directory}${appName}`, {
     ...(options as any),
-    ...getDefaultTemplateOptions(),
+    ...getDefaultTemplateOptions(tree),
     appname,
     directoryAppPath: `${directory}${options.name}`,
     pathOffset: directory ? '../../../' : '../../',
diff --git a/packages/nx/src/generators/library/library.spec.ts b/packages/nx/src/generators/library/library.spec.ts
@@ -26,9 +26,9 @@ describe('lib', () => {
       const projectConfig = readProjectConfiguration(tree, libName);
       expect(projectConfig.root).toEqual(`libs/${libName}`);
       expect(projectConfig.targets.lint).toEqual({
-        executor: '@nx/linter:eslint',
+        executor: '@nx/eslint:lint',
         options: {
-          lintFilePatterns: [`libs/${libName}/**/*.ts`],
+          lintFilePatterns: [`libs/${libName}/**/*.ts`, `libs/${libName}/package.json`],
         },
         outputs: ['{options.outputFile}'],
       });
@@ -41,9 +41,9 @@ describe('lib', () => {
 
       expect(projectConfig.root).toEqual(`libs/${libName}`);
       expect(projectConfig.targets.lint).toEqual({
-        executor: '@nx/linter:eslint',
+        executor: '@nx/eslint:lint',
         options: {
-          lintFilePatterns: [`libs/${libName}/**/*.ts`],
+          lintFilePatterns: [`libs/${libName}/**/*.ts`, `libs/${libName}/package.json`],
         },
         outputs: ['{options.outputFile}'],
       });
diff --git a/packages/nx/src/generators/library/library.ts b/packages/nx/src/generators/library/library.ts
@@ -8,19 +8,23 @@ export async function library(tree: Tree, options: any) {
   await initGenerator(tree, {
     skipFormat: true,
   });
+  const defaultDirectory = tree.exists('libs') ? 'libs' : (tree.exists('packages') ? 'packages' : '')
   await libraryGenerator(tree, {
     name: options.name,
-    directory: options.directory,
+    // ensure placed in starting location
+    directory: defaultDirectory ? options.directory : (options.directory ? `libs/${options.directory}` : 'libs'),
   });
 
   // add extra files
   const directory = options.directory ? `${options.directory}/` : '';
   generateFiles(tree, joinPathFragments(__dirname, 'files'), `libs/${directory}${options.name}`, {
     ...(options as any),
-    ...getDefaultTemplateOptions(),
+    ...getDefaultTemplateOptions(tree),
     pathOffset: directory ? '../../../' : '../../',
   });
 
+  console.log(tree.listChanges().map(c => `${c.path}\n`))
+
   // update library tsconfig for {N} development
   const tsConfigPath = `libs/${directory}${options.name}/tsconfig.json`;
   const tsConfigJson = readJson(tree, tsConfigPath);
diff --git a/packages/nx/src/utils/errors.ts b/packages/nx/src/utils/errors.ts
@@ -1,12 +1,12 @@
-import { stringUtils } from '@nx/workspace';
+import * as nxStringUtils from '@nx/devkit/src/utils/string-utils';
 import { supportedFrameworks } from './general';
 
 export function missingArgument(argName: string, description: string = '', example: string = '') {
   return `Missing ${argName} argument. ${description} ${example ? 'Example: ' + example : ''}`;
 }
 
 export function unsupportedFrameworkError(framework: string) {
-  return `${framework} is currently not a supported framework. Supported at the moment: ${supportedFrameworks.map((f) => stringUtils.capitalize(f))}. Please request support for this framework if you'd like and/or submit a PR which we would greatly appreciate.`;
+  return `${framework} is currently not a supported framework. Supported at the moment: ${supportedFrameworks.map((f) => nxStringUtils.capitalize(f))}. Please request support for this framework if you'd like and/or submit a PR which we would greatly appreciate.`;
 }
 
 export function generateOptionError(type: string, missingFeature?: boolean) {
diff --git a/packages/nx/src/utils/general.ts b/packages/nx/src/utils/general.ts
diff --git a/packages/nx/src/utils/helpers.ts b/packages/nx/src/utils/helpers.ts
diff --git a/packages/nx/src/utils/versions.ts b/packages/nx/src/utils/versions.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"generators": {},`
`7`	`7`	`"targets": {`
`8`	`8`	`"lint": {`
`9`		`- "executor": "@nx/linter:eslint",`
	`9`	`+ "executor": "@nx/eslint:lint",`
`10`	`10`	`"outputs": ["{options.outputFile}"],`
`11`	`11`	`"options": {`
`12`	`12`	`"lintFilePatterns": ["packages/nx/*/.ts"]`
`@@ -56,7 +56,8 @@`
`56`	`56`	`"glob": "migrations.json",`
`57`	`57`	`"output": "."`
`58`	`58`	`}`
`59`		`- ]`
	`59`	`+ ],`
	`60`	`+ "updateBuildableProjectDepsInPackageJson": true`
`60`	`61`	`}`
`61`	`62`	`}`
`62`	`63`	`},`