@nx/devkit 20.2.1 → 20.3.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "20.2.1",
+  "version": "20.3.0-beta.0",
   "private": false,
   "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more. Learn more about [extending Nx by leveraging the Nx Devkit](https://nx.dev/extending-nx/intro/getting-started) on our docs.",
   "repository": {

package/src/generators/artifact-name-and-directory-utils.d.ts

@@ -2,10 +2,19 @@ import { type Tree } from 'nx/src/devkit-exports';
 export type ArtifactGenerationOptions = {
     path: string;
     name?: string;
-    fileExtension?: 'js' | 'jsx' | 'ts' | 'tsx' | 'vue';
-    fileName?: string;
+    fileExtension?: string;
     suffix?: string;
+    allowedFileExtensions?: string[];
+    /**
+     * @deprecated Provide the full file path including the file extension in the `path` option. This option will be removed in Nx v21.
+     */
+    js?: boolean;
+    /**
+     * @deprecated Provide the full file path including the file extension in the `path` option. This option will be removed in Nx v21.
+     */
+    jsOptionName?: string;
 };
+export type FileExtensionType = 'js' | 'ts' | 'other';
 export type NameAndDirectoryOptions = {
     /**
      * Normalized artifact name.
@@ -19,6 +28,14 @@ export type NameAndDirectoryOptions = {
      * Normalized file name of the artifact without the extension.
      */
     fileName: string;
+    /**
+     * Normalized file extension.
+     */
+    fileExtension: string;
+    /**
+     * Normalized file extension type.
+     */
+    fileExtensionType: FileExtensionType;
     /**
      * Normalized full file path of the artifact.
      */

package/src/generators/artifact-name-and-directory-utils.js

@@ -6,6 +6,13 @@ exports.setCwd = setCwd;
 const devkit_exports_1 = require("nx/src/devkit-exports");
 const devkit_internals_1 = require("nx/src/devkit-internals");
 const path_1 = require("path");
+const DEFAULT_ALLOWED_JS_FILE_EXTENSIONS = ['js', 'cjs', 'mjs', 'jsx'];
+const DEFAULT_ALLOWED_TS_FILE_EXTENSIONS = ['ts', 'cts', 'mts', 'tsx'];
+const DEFAULT_ALLOWED_FILE_EXTENSIONS = [
+    ...DEFAULT_ALLOWED_JS_FILE_EXTENSIONS,
+    ...DEFAULT_ALLOWED_TS_FILE_EXTENSIONS,
+    'vue',
+];
 async function determineArtifactNameAndDirectoryOptions(tree, options) {
     const normalizedOptions = getNameAndDirectoryOptions(tree, options);
     validateResolvedProject(normalizedOptions.project, normalizedOptions.directory);
@@ -15,7 +22,6 @@ function getNameAndDirectoryOptions(tree, options) {
     const path = options.path
         ? (0, devkit_exports_1.normalizePath)(options.path.replace(/^\.?\//, ''))
         : undefined;
-    const fileExtension = options.fileExtension ?? 'ts';
     let { name: extractedName, directory } = extractNameAndDirectoryFromPath(path);
     const relativeCwd = getRelativeCwd();
     // append the directory to the current working directory if it doesn't start with it
@@ -23,15 +29,30 @@ function getNameAndDirectoryOptions(tree, options) {
         directory = (0, devkit_exports_1.joinPathFragments)(relativeCwd, directory);
     }
     const project = findProjectFromPath(tree, directory);
-    const name = options.fileName ??
-        (options.suffix ? `${extractedName}.${options.suffix}` : extractedName);
-    const filePath = (0, devkit_exports_1.joinPathFragments)(directory, `${name}.${fileExtension}`);
+    let fileName = extractedName;
+    let fileExtension = options.fileExtension ?? 'ts';
+    const allowedFileExtensions = options.allowedFileExtensions ?? DEFAULT_ALLOWED_FILE_EXTENSIONS;
+    const fileExtensionRegex = new RegExp(`\\.(${allowedFileExtensions.join('|')})$`);
+    const fileExtensionMatch = fileName.match(fileExtensionRegex);
+    if (fileExtensionMatch) {
+        fileExtension = fileExtensionMatch[1];
+        fileName = fileName.replace(fileExtensionRegex, '');
+        extractedName = fileName;
+    }
+    else if (options.suffix) {
+        fileName = `${fileName}.${options.suffix}`;
+    }
+    const filePath = (0, devkit_exports_1.joinPathFragments)(directory, `${fileName}.${fileExtension}`);
+    const fileExtensionType = getFileExtensionType(fileExtension);
+    validateFileExtension(fileExtension, allowedFileExtensions, options.js, options.jsOptionName);
     return {
         artifactName: options.name ?? extractedName,
-        directory: directory,
-        fileName: name,
-        filePath: filePath,
-        project: project,
+        directory,
+        fileName,
+        fileExtension,
+        fileExtensionType,
+        filePath,
+        project,
     };
 }
 function validateResolvedProject(project, normalizedDirectory) {
@@ -72,3 +93,31 @@ function extractNameAndDirectoryFromPath(path) {
     const directory = parsedPath.join('/');
     return { name, directory };
 }
+function getFileExtensionType(fileExtension) {
+    if (DEFAULT_ALLOWED_JS_FILE_EXTENSIONS.includes(fileExtension)) {
+        return 'js';
+    }
+    if (DEFAULT_ALLOWED_TS_FILE_EXTENSIONS.includes(fileExtension)) {
+        return 'ts';
+    }
+    return 'other';
+}
+function validateFileExtension(fileExtension, allowedFileExtensions, js, jsOptionName) {
+    const fileExtensionType = getFileExtensionType(fileExtension);
+    if (!allowedFileExtensions.includes(fileExtension)) {
+        throw new Error(`The provided file path has an extension (.${fileExtension}) that is not supported by this generator.
+The supported extensions are: ${allowedFileExtensions
+            .map((ext) => `.${ext}`)
+            .join(', ')}.`);
+    }
+    if (js !== undefined) {
+        jsOptionName = jsOptionName ?? 'js';
+        if (js && fileExtensionType === 'ts') {
+            throw new Error(`The provided file path has an extension (.${fileExtension}) that conflicts with the provided "--${jsOptionName}" option.`);
+        }
+        if (!js && fileExtensionType === 'js') {
+            throw new Error(`The provided file path has an extension (.${fileExtension}) that conflicts with the provided "--${jsOptionName}" option.`);
+        }
+    }
+    return fileExtensionType;
+}