@nx/js 20.0.0-beta.3 → 20.0.0-beta.5

package/generators.json

@@ -10,7 +10,7 @@
       "description": "Create a library"
     },
     "init": {
-      "factory": "./src/generators/init/init#initGenerator",
+      "factory": "./src/generators/init/init#initGeneratorInternal",
       "schema": "./src/generators/init/schema.json",
       "aliases": ["lib"],
       "x-type": "init",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "20.0.0-beta.3",
+  "version": "20.0.0-beta.5",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -39,8 +39,9 @@
     "@babel/preset-env": "^7.23.2",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime": "^7.22.6",
-    "@nx/devkit": "20.0.0-beta.3",
-    "@nx/workspace": "20.0.0-beta.3",
+    "@nx/devkit": "20.0.0-beta.5",
+    "@nx/workspace": "20.0.0-beta.5",
+    "@zkochan/js-yaml": "0.0.7",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^2.8.0",
     "babel-plugin-transform-typescript-metadata": "^0.3.1",
@@ -60,8 +61,7 @@
     "source-map-support": "0.5.19",
     "ts-node": "10.9.1",
     "tsconfig-paths": "^4.1.2",
-    "tslib": "^2.3.0",
-    "@nrwl/js": "20.0.0-beta.3"
+    "tslib": "^2.3.0"
   },
   "peerDependencies": {
     "verdaccio": "^5.0.4"

package/src/generators/init/files/ts-solution/tsconfig.base.json__tmpl__

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "allowJs": false,
+    "allowSyntheticDefaultImports": true,
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "emitDecoratorMetadata": false,
+    "esModuleInterop": true,
+    "experimentalDecorators": false,
+    "forceConsistentCasingInFileNames": true,
+    "importHelpers": true,
+    "incremental": true,
+    "isolatedModules": true,
+    "lib": ["es2022"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": false,
+    "skipDefaultLibCheck": false,
+    "skipLibCheck": true,
+    "sourceMap": false,
+    "strict": true,
+    "target": "es2022",
+    "verbatimModuleSyntax": false
+  }
+}

package/src/generators/init/files/ts-solution/tsconfig.json__tmpl__

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compileOnSave": false,
+  "files": [],
+  "references": []
+}

package/src/generators/init/init.js

@@ -3,12 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initGenerator = initGenerator;
 exports.initGeneratorInternal = initGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
+const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
 const semver_1 = require("@nx/devkit/src/utils/semver");
 const package_json_1 = require("nx/src/utils/package-json");
 const path_1 = require("path");
 const semver_2 = require("semver");
+const plugin_1 = require("../../plugins/typescript/plugin");
 const prettier_1 = require("../../utils/prettier");
 const ts_config_1 = require("../../utils/typescript/ts-config");
+const ts_solution_setup_1 = require("../../utils/typescript/ts-solution-setup");
 const versions_1 = require("../../utils/versions");
 async function getInstalledTypescriptVersion(tree) {
     const rootPackageJson = (0, devkit_1.readJson)(tree, 'package.json');
@@ -37,19 +40,47 @@ async function getInstalledTypescriptVersion(tree) {
     }
 }
 async function initGenerator(tree, schema) {
+    schema.addTsPlugin ??= false;
+    const isUsingNewTsSetup = schema.addTsPlugin || (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    schema.formatter ??= isUsingNewTsSetup ? 'none' : 'prettier';
     return initGeneratorInternal(tree, {
         addTsConfigBase: true,
-        setUpPrettier: true,
         ...schema,
     });
 }
 async function initGeneratorInternal(tree, schema) {
     const tasks = [];
-    // add tsconfig.base.json
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    schema.addPlugin ??=
+        process.env.NX_ADD_PLUGINS !== 'false' &&
+            nxJson.useInferencePlugins !== false;
+    schema.addTsPlugin ??=
+        schema.addPlugin && process.env.NX_ADD_TS_PLUGIN === 'true';
+    if (schema.addTsPlugin) {
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/js/typescript', plugin_1.createNodesV2, {
+            typecheck: [
+                { targetName: 'typecheck' },
+                { targetName: 'tsc:typecheck' },
+                { targetName: 'tsc-typecheck' },
+            ],
+            build: [
+                { targetName: 'build', configName: 'tsconfig.lib.json' },
+                { targetName: 'tsc:build', configName: 'tsconfig.lib.json' },
+                { targetName: 'tsc-build', configName: 'tsconfig.lib.json' },
+            ],
+        }, schema.updatePackageScripts);
+    }
     if (schema.addTsConfigBase && !(0, ts_config_1.getRootTsConfigFileName)(tree)) {
-        (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files'), '.', {
-            fileName: schema.tsConfigName ?? 'tsconfig.base.json',
-        });
+        if (schema.addTsPlugin) {
+            (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files/ts-solution'), '.', {
+                tmpl: '',
+            });
+        }
+        else {
+            (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files/non-ts-solution'), '.', {
+                fileName: schema.tsConfigName ?? 'tsconfig.base.json',
+            });
+        }
     }
     const devDependencies = {
         '@nx/js': versions_1.nxVersion,
@@ -68,7 +99,7 @@ async function initGeneratorInternal(tree, schema) {
             devDependencies['typescript'] = versions_1.typescriptVersion;
         }
     }
-    if (schema.setUpPrettier) {
+    if (schema.formatter === 'prettier') {
         const prettierTask = (0, prettier_1.generatePrettierSetup)(tree, {
             skipPackageJson: schema.skipPackageJson,
         });
@@ -87,7 +118,10 @@ async function initGeneratorInternal(tree, schema) {
         ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, devDependencies, undefined, schema.keepExistingVersions)
         : () => { };
     tasks.push(installTask);
-    if (!schema.skipPackageJson && schema.setUpPrettier) {
+    if (!schema.skipPackageJson &&
+        // For `create-nx-workspace` or `nx g @nx/js:init`, we want to make sure users didn't set formatter to none.
+        // For programmatic usage, the formatter is normally undefined, and we want prettier to continue to be ensured, even if not ultimately installed.
+        schema.formatter !== 'none') {
         (0, devkit_1.ensurePackage)('prettier', versions_1.prettierVersion);
     }
     if (!schema.skipFormat) {

package/src/generators/init/schema.d.ts

@@ -1,9 +1,12 @@
 export interface InitSchema {
   addTsConfigBase?: boolean;
+  formatter?: 'none' | 'prettier';
   js?: boolean;
   keepExistingVersions?: boolean;
-  setUpPrettier?: boolean;
   skipFormat?: boolean;
   skipPackageJson?: boolean;
   tsConfigName?: string;
+  addPlugin?: boolean;
+  updatePackageScripts?: boolean;
+  addTsPlugin?: boolean;
 }

package/src/generators/init/schema.json

@@ -5,6 +5,12 @@
   "title": "Init nx/js",
   "description": "Init generator placeholder for nx/js.",
   "properties": {
+    "formatter": {
+      "description": "The tool to use for code formatting.",
+      "type": "string",
+      "enum": ["none", "prettier"],
+      "default": "none"
+    },
     "js": {
       "type": "boolean",
       "default": false,
@@ -37,12 +43,6 @@
       "type": "string",
       "description": "Customize the generated base tsconfig file name.",
       "x-priority": "internal"
-    },
-    "setUpPrettier": {
-      "type": "boolean",
-      "description": "Add Prettier and corresponding configuration files.",
-      "x-priority": "internal",
-      "default": false
     }
   }
 }

package/src/generators/library/files/lib/src/lib/__fileName__.spec.ts__tmpl__

@@ -1,7 +1,7 @@
 import { <%= propertyName %> } from './<%= fileName %>';
 
 describe('<%= propertyName %>', () => {
-    it('should work', () => {
-        expect(<%= propertyName %>()).toEqual('<%= name %>');
-    })
-})
+  it('should work', () => {
+    expect(<%= propertyName %>()).toEqual('<%= name %>');
+  })
+})

package/src/generators/library/files/lib/src/lib/__fileName__.ts__tmpl__

@@ -1,3 +1,3 @@
 export function <%= propertyName %>(): string {
-    return '<%= name %>';
+  return '<%= name %>';
 }

package/src/generators/library/files/readme/README.md

@@ -1,19 +1,11 @@
 # <%= name %>
 
-This library was generated with [Nx](https://nx.dev).
-
-<% if (buildable) { %>
+This library was generated with [Nx](https://nx.dev).<% if (buildable) { %>
 
 ## Building
 
-Run `<%= cliCommand %> build <%= name %>` to build the library.
-
-<% } %>
-
-<% if (hasUnitTestRunner) { %>
+Run `<%= cliCommand %> build <%= name %>` to build the library.<% } %><% if (unitTestRunner !== 'none') { %>
 
 ## Running unit tests
 
-Run `<%= cliCommand %> test <%= name %>` to execute the unit tests via <% if(unitTestRunner === 'jest') { %>[Jest](https://jestjs.io)<% } else { %>[Vitest](https://vitest.dev/)<% } %>.
-
-<% } %>
+Run `<%= cliCommand %> test <%= name %>` to execute the unit tests via <% if(unitTestRunner === 'jest') { %>[Jest](https://jestjs.io)<% } else { %>[Vitest](https://vitest.dev/)<% } %>.<% } %>

package/src/generators/library/files/tsconfig-lib/ts-solution/tsconfig.lib.json__tmpl__

@@ -0,0 +1,14 @@
+{
+  "extends": "<%= offsetFromRoot %>tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "src",
+    "outDir": "dist",
+    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
+    "emitDeclarationOnly": false,<% if (compilerOptions.length) { %>
+    <%- compilerOptions %>,<% } %>
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"<% if (js) { %>, "src/**/*.js"<% } %>],
+  "references": []
+}

package/src/generators/library/library.d.ts

@@ -1,16 +1,7 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
-import { type ProjectNameAndRootOptions } from '@nx/devkit/src/generators/project-name-and-root-utils';
-import { LibraryGeneratorSchema } from '../../utils/schema';
+import type { LibraryGeneratorSchema, NormalizedLibraryGeneratorOptions } from './schema';
 export declare function libraryGenerator(tree: Tree, schema: LibraryGeneratorSchema): Promise<GeneratorCallback>;
 export declare function libraryGeneratorInternal(tree: Tree, schema: LibraryGeneratorSchema): Promise<GeneratorCallback>;
-export interface NormalizedSchema extends LibraryGeneratorSchema {
-    name: string;
-    projectNames: ProjectNameAndRootOptions['names'];
-    fileName: string;
-    projectRoot: string;
-    parsedTags: string[];
-    importPath?: string;
-}
-export type AddLintOptions = Pick<NormalizedSchema, 'name' | 'linter' | 'projectRoot' | 'unitTestRunner' | 'js' | 'setParserOptionsProject' | 'rootProject' | 'bundler' | 'addPlugin'>;
+export type AddLintOptions = Pick<NormalizedLibraryGeneratorOptions, 'name' | 'linter' | 'projectRoot' | 'unitTestRunner' | 'js' | 'setParserOptionsProject' | 'rootProject' | 'bundler' | 'addPlugin'>;
 export declare function addLint(tree: Tree, options: AddLintOptions): Promise<GeneratorCallback>;
 export default libraryGenerator;