@nx/js 23.2.0-beta.8 → 23.2.0-beta.9

package/dist/src/generators/init/init.js

@@ -7,15 +7,27 @@ const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const plugin_1 = require("../../plugins/typescript/plugin");
 const assert_supported_typescript_version_1 = require("../../utils/assert-supported-typescript-version");
-const prettier_1 = require("../../utils/prettier");
+const formatter_setup_1 = require("../../utils/formatter-setup");
+const nx_formatter_internals_1 = require("../../utils/nx-formatter-internals");
 const create_ts_config_1 = require("../../utils/typescript/create-ts-config");
 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 initGenerator(tree, schema) {
     schema.addTsPlugin ??= false;
-    const isUsingNewTsSetup = schema.addTsPlugin || (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
-    schema.formatter ??= isUsingNewTsSetup ? 'none' : 'prettier';
+    // Detection is the only thing here that needs the nx-side helpers, so the
+    // assert belongs with it: `'none'` must still work on an older peer-compatible
+    // nx, and it reaches no formatter code at all. An explicit `'prettier'` or
+    // `'oxfmt'` does not - both setups assert for themselves.
+    if (schema.formatter == null) {
+        (0, nx_formatter_internals_1.assertNxSupportsFormatters)();
+        // Defer to `detectFormatterInTree` rather than re-deriving: it encodes the
+        // oxfmt-over-prettier precedence, which a prettier-first check gets
+        // backwards for a workspace configured with both. Falling back to "none"
+        // rather than a formatter keeps this from installing one the caller never
+        // asked for.
+        schema.formatter = (0, internal_1.detectFormatterInTree)(tree) ?? 'none';
+    }
     return initGeneratorInternal(tree, {
         addTsConfigBase: true,
         ...schema,
@@ -90,11 +102,13 @@ async function initGeneratorInternal(tree, schema) {
     if (!schema.js) {
         devDependencies['typescript'] = versions_1.typescriptVersion;
     }
-    if (schema.formatter === 'prettier') {
-        const prettierTask = (0, prettier_1.generatePrettierSetup)(tree, {
-            skipPackageJson: schema.skipPackageJson,
-        });
-        tasks.push(prettierTask);
+    // One table drives both halves of formatter setup - writing the config and
+    // making the package resolvable further down. They were separate `if` chains
+    // over the same union, forty lines apart, so a third formatter meant finding
+    // both.
+    const formatterSetup = (0, formatter_setup_1.getFormatterSetup)(schema.formatter);
+    if (formatterSetup) {
+        tasks.push(formatterSetup.setUp(tree, { skipPackageJson: schema.skipPackageJson }));
     }
     const rootTsConfigFileName = (0, ts_config_1.getRootTsConfigFileName)(tree);
     // If the root tsconfig file uses `importHelpers` then we must install tslib
@@ -109,15 +123,18 @@ async function initGeneratorInternal(tree, schema) {
         ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, devDependencies, undefined, schema.keepExistingVersions ?? true)
         : () => { };
     tasks.push(installTask);
-    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);
+    // `installTask` is queued, not run, so the formatter just added to
+    // package.json is not on disk yet; ensurePackage installs it out of band.
+    // Not gated on `skipFormat` - callers that pass it format later in this same
+    // process.
+    const isDryRun = !!process.env.NX_DRY_RUN && process.env.NX_DRY_RUN !== 'false';
+    if (formatterSetup &&
+        !schema.skipPackageJson &&
+        !isDryRun &&
+        process.env.NX_SKIP_FORMAT !== 'true') {
+        (0, devkit_1.ensurePackage)(schema.formatter, formatterSetup.version);
     }
     if (!schema.skipFormat) {
-        // even if skipPackageJson === true, we can safely run formatFiles, prettier might
-        // have been installed earlier and if not, the formatFiles function still handles it
         await (0, devkit_1.formatFiles)(tree);
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);

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

@@ -1,6 +1,6 @@
 export interface InitSchema {
   addTsConfigBase?: boolean;
-  formatter?: 'none' | 'prettier';
+  formatter?: 'none' | 'prettier' | 'oxfmt';
   js?: boolean;
   keepExistingVersions?: boolean;
   skipFormat?: boolean;

package/dist/src/generators/init/schema.json

@@ -8,7 +8,7 @@
     "formatter": {
       "description": "The tool to use for code formatting.",
       "type": "string",
-      "enum": ["none", "prettier"],
+      "enum": ["none", "prettier", "oxfmt"],
       "default": "none"
     },
     "js": {

package/dist/src/generators/library/library.js

@@ -41,8 +41,6 @@ async function libraryGeneratorInternal(tree, schema) {
         tsConfigName: schema.rootProject ? 'tsconfig.json' : 'tsconfig.base.json',
         addTsConfigBase: true,
         addTsPlugin,
-        // In the new setup, Prettier is prompted for and installed during `create-nx-workspace`.
-        formatter: (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree) ? 'none' : 'prettier',
     }));
     const options = await normalizeOptions(tree, schema);
     createFiles(tree, options);

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

@@ -15,6 +15,7 @@ export interface LibraryGeneratorSchema {
   includeBabelRc?: boolean;
   unitTestRunner?: 'jest' | 'vitest' | 'none';
   linter?: LinterType;
+  formatter?: 'none' | 'prettier' | 'oxfmt';
   testEnvironment?: 'jsdom' | 'node';
   importPath?: string;
   js?: boolean;

package/dist/src/generators/library/schema.json

@@ -34,6 +34,11 @@
       "enum": ["none", "eslint", "oxlint"],
       "x-priority": "important"
     },
+    "formatter": {
+      "description": "The tool to use for code formatting.",
+      "type": "string",
+      "enum": ["none", "prettier", "oxfmt"]
+    },
     "unitTestRunner": {
       "description": "Test runner to use for unit tests.",
       "type": "string",

package/dist/src/index.d.ts

@@ -13,6 +13,7 @@ export * from './utils/package-json/update-package-json';
 export * from './utils/package-json/create-entry-points';
 export { libraryGenerator } from './generators/library/library';
 export { initGenerator } from './generators/init/init';
+export { setUpFormatter } from './utils/formatter-setup';
 export { setupPrettierGenerator } from './generators/setup-prettier/generator';
 export { setupVerdaccio } from './generators/setup-verdaccio/generator';
 export { isValidVariable } from './utils/is-valid-variable';

package/dist/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackageJson = exports.getLockFileName = exports.createLockFile = exports.isValidVariable = exports.setupVerdaccio = exports.setupPrettierGenerator = exports.initGenerator = exports.libraryGenerator = void 0;
+exports.createPackageJson = exports.getLockFileName = exports.createLockFile = exports.isValidVariable = exports.setupVerdaccio = exports.setupPrettierGenerator = exports.setUpFormatter = exports.initGenerator = exports.libraryGenerator = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./utils/typescript/add-tslib-dependencies"), exports);
 tslib_1.__exportStar(require("./utils/typescript/load-ts-transformers"), exports);
@@ -19,6 +19,8 @@ var library_1 = require("./generators/library/library");
 Object.defineProperty(exports, "libraryGenerator", { enumerable: true, get: function () { return library_1.libraryGenerator; } });
 var init_1 = require("./generators/init/init");
 Object.defineProperty(exports, "initGenerator", { enumerable: true, get: function () { return init_1.initGenerator; } });
+var formatter_setup_1 = require("./utils/formatter-setup");
+Object.defineProperty(exports, "setUpFormatter", { enumerable: true, get: function () { return formatter_setup_1.setUpFormatter; } });
 var generator_1 = require("./generators/setup-prettier/generator");
 Object.defineProperty(exports, "setupPrettierGenerator", { enumerable: true, get: function () { return generator_1.setupPrettierGenerator; } });
 var generator_2 = require("./generators/setup-verdaccio/generator");

package/dist/src/utils/formatter-setup.d.ts

@@ -0,0 +1,26 @@
+import type { GeneratorCallback, Tree } from '@nx/devkit';
+type FormatterSetup = {
+    setUp: (tree: Tree, options: {
+        skipPackageJson?: boolean;
+    }) => GeneratorCallback;
+    version: string;
+};
+/**
+ * The setup for a formatter name that came from a schema, or `undefined` for
+ * `'none'` and anything unrecognised.
+ *
+ * `hasOwnProperty` rather than `in`, which would answer `true` for inherited
+ * members like `'constructor'` and hand back an `Object.prototype` function.
+ */
+export declare function getFormatterSetup(formatter: string | undefined): FormatterSetup | undefined;
+/**
+ * Writes the chosen formatter's config and queues its install.
+ *
+ * For callers that only need the formatter configured - a preset that creates
+ * an empty workspace, say - rather than the whole of `@nx/js:init`. Does
+ * nothing for `'none'` or an unrecognised value.
+ */
+export declare function setUpFormatter(tree: Tree, formatter: string | undefined, options?: {
+    skipPackageJson?: boolean;
+}): GeneratorCallback;
+export {};

package/dist/src/utils/formatter-setup.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFormatterSetup = getFormatterSetup;
+exports.setUpFormatter = setUpFormatter;
+const oxfmt_1 = require("./oxfmt");
+const prettier_1 = require("./prettier");
+const versions_1 = require("./versions");
+/**
+ * Not `Partial`, so a new `FormatterType` member fails to compile here until it
+ * is set up - but only after `packages/nx` is rebuilt, since the type comes
+ * from its emitted declarations. The guard must stay structural: under
+ * `strict: false` an untyped lookup yields `any` instead of an error.
+ *
+ * The key doubles as the npm package name; callers install by it.
+ */
+const formatterSetups = {
+    prettier: { setUp: prettier_1.generatePrettierSetup, version: versions_1.prettierVersion },
+    oxfmt: { setUp: oxfmt_1.generateOxfmtSetup, version: versions_1.oxfmtVersion },
+};
+/**
+ * The setup for a formatter name that came from a schema, or `undefined` for
+ * `'none'` and anything unrecognised.
+ *
+ * `hasOwnProperty` rather than `in`, which would answer `true` for inherited
+ * members like `'constructor'` and hand back an `Object.prototype` function.
+ */
+function getFormatterSetup(formatter) {
+    return formatter !== undefined &&
+        Object.prototype.hasOwnProperty.call(formatterSetups, formatter)
+        ? formatterSetups[formatter]
+        : undefined;
+}
+/**
+ * Writes the chosen formatter's config and queues its install.
+ *
+ * For callers that only need the formatter configured - a preset that creates
+ * an empty workspace, say - rather than the whole of `@nx/js:init`. Does
+ * nothing for `'none'` or an unrecognised value.
+ */
+function setUpFormatter(tree, formatter, options = {}) {
+    const setup = getFormatterSetup(formatter);
+    return setup ? setup.setUp(tree, options) : () => { };
+}

package/dist/src/utils/nx-formatter-internals.d.ts

@@ -0,0 +1,8 @@
+/**
+ * `@nx/js` inherits `@nx/devkit`'s `nx` peer, which spans a major either
+ * side, so an older nx without these helpers can legally be installed. A
+ * missing CommonJS named export arrives as `undefined`, so the first use
+ * would otherwise be a bare `undefined.every` naming neither package nor
+ * cause.
+ */
+export declare function assertNxSupportsFormatters(): void;

package/dist/src/utils/nx-formatter-internals.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertNxSupportsFormatters = assertNxSupportsFormatters;
+const internal_1 = require("@nx/devkit/internal");
+/**
+ * `@nx/js` inherits `@nx/devkit`'s `nx` peer, which spans a major either
+ * side, so an older nx without these helpers can legally be installed. A
+ * missing CommonJS named export arrives as `undefined`, so the first use
+ * would otherwise be a bare `undefined.every` naming neither package nor
+ * cause.
+ */
+function assertNxSupportsFormatters() {
+    if (internal_1.detectFormatterInTree && internal_1.oxfmtConfigFiles && internal_1.prettierConfigFiles) {
+        return;
+    }
+    throw new Error('The installed version of nx does not export the formatter helpers that @nx/js needs to detect and set up a formatter. ' +
+        'This happens when nx and @nx/js are on different major versions. Run `nx migrate latest` to bring them into line.');
+}

package/dist/src/utils/oxfmt.d.ts

@@ -0,0 +1,4 @@
+import { type GeneratorCallback, type Tree } from '@nx/devkit';
+export declare function generateOxfmtSetup(tree: Tree, options: {
+    skipPackageJson?: boolean;
+}): GeneratorCallback;

package/dist/src/utils/oxfmt.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOxfmtSetup = generateOxfmtSetup;
+const devkit_1 = require("@nx/devkit");
+// Imported rather than copied: detection ("is this workspace using oxfmt?")
+// and setup ("should a config be written?") have to agree on the same list, or
+// a workspace that already has a config gets a second, redundant one.
+const internal_1 = require("@nx/devkit/internal");
+const nx_formatter_internals_1 = require("./nx-formatter-internals");
+const versions_1 = require("./versions");
+function generateOxfmtSetup(tree, options) {
+    (0, nx_formatter_internals_1.assertNxSupportsFormatters)();
+    if (internal_1.oxfmtConfigFiles.every((name) => !tree.exists(name))) {
+        // oxfmt defaults to double quotes and we prefer single, so that is the one
+        // option worth setting. Line width is left at oxfmt's default.
+        (0, devkit_1.writeJson)(tree, '.oxfmtrc.json', { singleQuote: true });
+    }
+    // The oxc extension is what drives oxfmt in the editor, so recommend it for
+    // the same reason the prettier setup recommends its own. Only when the file
+    // is already there - creating it would push an editor choice on a workspace
+    // that has not made one.
+    if (tree.exists('.vscode/extensions.json')) {
+        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
+            json.recommendations ??= [];
+            const extension = 'oxc.oxc-vscode';
+            if (!json.recommendations.includes(extension)) {
+                json.recommendations.push(extension);
+            }
+            return json;
+        });
+    }
+    return options.skipPackageJson
+        ? () => { }
+        : (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { oxfmt: versions_1.oxfmtVersion });
+}

package/dist/src/utils/prettier.js

@@ -4,6 +4,8 @@ exports.resolveUserExistingPrettierConfig = resolveUserExistingPrettierConfig;
 exports.generatePrettierSetup = generatePrettierSetup;
 exports.resolvePrettierConfigPath = resolvePrettierConfigPath;
 const devkit_1 = require("@nx/devkit");
+const internal_1 = require("@nx/devkit/internal");
+const nx_formatter_internals_1 = require("./nx-formatter-internals");
 const versions_1 = require("./versions");
 // Prettier v3 (ESM) exposes its API as named exports; v2 (CJS) exposes it under
 // `.default` when loaded via `import()`. Return whichever carries the API, or
@@ -44,22 +46,11 @@ async function resolveUserExistingPrettierConfig() {
     }
 }
 function generatePrettierSetup(tree, options) {
-    // https://prettier.io/docs/en/configuration.html
-    const prettierrcNameOptions = [
-        '.prettierrc',
-        '.prettierrc.json',
-        '.prettierrc.yml',
-        '.prettierrc.yaml',
-        '.prettierrc.json5',
-        '.prettierrc.js',
-        '.prettierrc.cjs',
-        '.prettierrc.mjs',
-        '.prettierrc.toml',
-        'prettier.config.js',
-        'prettier.config.cjs',
-        'prettier.config.mjs',
-    ];
-    if (prettierrcNameOptions.every((name) => !tree.exists(name))) {
+    (0, nx_formatter_internals_1.assertNxSupportsFormatters)();
+    // Imported rather than copied: detection and setup have to agree on this
+    // list, or a workspace whose config format is missing from one side gets a
+    // second, redundant `.prettierrc` written beside the one it already has.
+    if (internal_1.prettierConfigFiles.every((name) => !tree.exists(name))) {
         (0, devkit_1.writeJson)(tree, '.prettierrc', { singleQuote: true });
     }
     if (!tree.exists('.prettierignore')) {
@@ -68,6 +59,7 @@ function generatePrettierSetup(tree, options) {
         /coverage
         /.nx/cache
         /.nx/workspace-data
+        ${(0, internal_1.getLockFileName)((0, devkit_1.detectPackageManager)(tree.root))}
       `);
     }
     if (tree.exists('.vscode/extensions.json')) {
@@ -85,6 +77,7 @@ function generatePrettierSetup(tree, options) {
         : (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { prettier: versions_1.prettierVersion });
 }
 async function resolvePrettierConfigPath(tree) {
+    (0, nx_formatter_internals_1.assertNxSupportsFormatters)();
     const prettier = await importPrettier();
     if (!prettier) {
         return null;
@@ -96,23 +89,11 @@ async function resolvePrettierConfigPath(tree) {
     if (!tree) {
         return null;
     }
-    // if we haven't find a config file in the file system, we try to find it in the virtual tree
-    // https://prettier.io/docs/en/configuration.html
-    const prettierrcNameOptions = [
-        '.prettierrc',
-        '.prettierrc.json',
-        '.prettierrc.yml',
-        '.prettierrc.yaml',
-        '.prettierrc.json5',
-        '.prettierrc.js',
-        '.prettierrc.cjs',
-        '.prettierrc.mjs',
-        '.prettierrc.toml',
-        'prettier.config.js',
-        'prettier.config.cjs',
-        'prettier.config.mjs',
-    ];
-    const filePath = prettierrcNameOptions.find((file) => tree.exists(file));
+    // Same shared list as the setup above, so a config this can't see is one the
+    // setup would overwrite. The copy this replaced was missing the `.ts`,
+    // `.mts` and `.cts` forms.
+    // https://prettier.io/docs/configuration
+    const filePath = internal_1.prettierConfigFiles.find((file) => tree.exists(file));
     if (filePath) {
         return filePath;
     }

package/dist/src/utils/versions.d.ts

@@ -1,5 +1,6 @@
 export declare const nxVersion: any;
 export declare const esbuildVersion = "^0.27.0";
+export declare const oxfmtVersion = "^0.60.0";
 export declare const prettierVersion = "~3.6.2";
 export declare const swcCliVersion = "~0.8.1";
 export declare const swcCoreVersion = "~1.15.5";

package/dist/src/utils/versions.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.minSupportedTypescriptVersion = exports.typescriptVersion = exports.verdaccioVersion = exports.typesNodeVersion = exports.tsLibVersion = exports.swcNodeVersion = exports.swcHelpersVersion = exports.swcCoreVersion = exports.swcCliVersion = exports.prettierVersion = exports.esbuildVersion = exports.nxVersion = void 0;
+exports.minSupportedTypescriptVersion = exports.typescriptVersion = exports.verdaccioVersion = exports.typesNodeVersion = exports.tsLibVersion = exports.swcNodeVersion = exports.swcHelpersVersion = exports.swcCoreVersion = exports.swcCliVersion = exports.prettierVersion = exports.oxfmtVersion = exports.esbuildVersion = exports.nxVersion = void 0;
 const path_1 = require("path");
 exports.nxVersion = require((0, path_1.join)('@nx/js', 'package.json')).version;
 exports.esbuildVersion = '^0.27.0';
+exports.oxfmtVersion = '^0.60.0';
 exports.prettierVersion = '~3.6.2';
 exports.swcCliVersion = '~0.8.1';
 exports.swcCoreVersion = '~1.15.5';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "23.2.0-beta.8",
+  "version": "23.2.0-beta.9",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -147,18 +147,18 @@
     "source-map-support": "0.5.19",
     "tinyglobby": "^0.2.12",
     "tslib": "^2.3.0",
-    "@nx/devkit": "23.2.0-beta.8",
-    "@nx/workspace": "23.2.0-beta.8"
+    "@nx/devkit": "23.2.0-beta.9",
+    "@nx/workspace": "23.2.0-beta.9"
   },
   "devDependencies": {
-    "@nx/esbuild": "23.2.0-beta.8",
-    "@nx/eslint": "23.2.0-beta.8",
-    "@nx/jest": "23.2.0-beta.8",
-    "@nx/oxlint": "23.2.0-beta.8",
-    "@nx/vite": "23.2.0-beta.8",
-    "@nx/rollup": "23.2.0-beta.8",
-    "@nx/vitest": "23.2.0-beta.8",
-    "nx": "23.2.0-beta.8"
+    "@nx/esbuild": "23.2.0-beta.9",
+    "@nx/eslint": "23.2.0-beta.9",
+    "@nx/jest": "23.2.0-beta.9",
+    "@nx/oxlint": "23.2.0-beta.9",
+    "@nx/vite": "23.2.0-beta.9",
+    "@nx/vitest": "23.2.0-beta.9",
+    "@nx/rollup": "23.2.0-beta.9",
+    "nx": "23.2.0-beta.9"
   },
   "peerDependencies": {
     "@swc/cli": ">=0.6.0 <0.9.0",