fix(misc): allow --js flag to be passed to @nrwl/web:lib schematic (#3230)

BigAB · web-flow · commit afd99b27de03 · 2020-08-18T22:07:33.000-04:00
* fix(misc): allow --js flag to be passed to @nrwl/web:lib schematic creates js files instead of ts files s ISSUES CLOSED: #2985 * fix(misc): add tests for --js flag in workspace
diff --git a/docs/angular/api-workspace/schematics/library.md b/docs/angular/api-workspace/schematics/library.md
@@ -48,6 +48,14 @@ Type: `string`
 
 The library name used to import it, like @myorg/my-awesome-lib
 
+### js
+
+Default: `false`
+
+Type: `boolean`
+
+Generate JavaScript files rather than TypeScript files
+
 ### linter
 
 Default: `eslint`
diff --git a/docs/react/api-workspace/schematics/library.md b/docs/react/api-workspace/schematics/library.md
@@ -48,6 +48,14 @@ Type: `string`
 
 The library name used to import it, like @myorg/my-awesome-lib
 
+### js
+
+Default: `false`
+
+Type: `boolean`
+
+Generate JavaScript files rather than TypeScript files
+
 ### linter
 
 Default: `eslint`
diff --git a/packages/workspace/src/schematics/library/library.spec.ts b/packages/workspace/src/schematics/library/library.spec.ts
@@ -302,4 +302,43 @@ describe('lib', () => {
       expect.assertions(1);
     });
   });
+
+  describe('--js flag', () => {
+    it('should generate js files instead of ts files', async () => {
+      const tree = await runSchematic(
+        'lib',
+        { name: 'myLib', js: true },
+        appTree
+      );
+      expect(tree.exists(`libs/my-lib/jest.config.js`)).toBeTruthy();
+      expect(tree.exists('libs/my-lib/src/index.js')).toBeTruthy();
+      expect(tree.exists('libs/my-lib/src/lib/my-lib.js')).toBeTruthy();
+    });
+
+    it('should update root tsconfig.json with a js file path', async () => {
+      const tree = await runSchematic(
+        'lib',
+        { name: 'myLib', js: true },
+        appTree
+      );
+      const tsconfigJson = readJsonInTree(tree, '/tsconfig.base.json');
+      expect(tsconfigJson.compilerOptions.paths['@proj/my-lib']).toEqual([
+        'libs/my-lib/src/index.js',
+      ]);
+    });
+
+    it('should generate js files for nested libs as well', async () => {
+      const tree = await runSchematic(
+        'lib',
+        { name: 'myLib', directory: 'myDir', js: true },
+        appTree
+      );
+      expect(tree.exists(`libs/my-dir/my-lib/jest.config.js`)).toBeTruthy();
+      expect(tree.exists('libs/my-dir/my-lib/src/index.js')).toBeTruthy();
+      expect(
+        tree.exists('libs/my-dir/my-lib/src/lib/my-dir-my-lib.js')
+      ).toBeTruthy();
+      expect(tree.exists('libs/my-dir/my-lib/src/index.js')).toBeTruthy();
+    });
+  });
 });
diff --git a/packages/workspace/src/schematics/library/library.ts b/packages/workspace/src/schematics/library/library.ts
@@ -15,14 +15,16 @@ import {
 import { join, normalize } from '@angular-devkit/core';
 import { Schema } from './schema';
 
-import { NxJson, updateWorkspaceInTree, getNpmScope } from '@nrwl/workspace';
-import { updateJsonInTree, readJsonInTree } from '@nrwl/workspace';
+import { updateWorkspaceInTree, getNpmScope } from '@nrwl/workspace';
+import { updateJsonInTree } from '@nrwl/workspace';
 import { toFileName, names } from '@nrwl/workspace';
 import { formatFiles } from '@nrwl/workspace';
 import { offsetFromRoot } from '@nrwl/workspace';
+
 import { generateProjectLint, addLintFiles } from '../../utils/lint';
 import { addProjectToNxJsonInTree, libsDir } from '../../utils/ast-utils';
 import { cliCommand } from '../../core/file-utils';
+import { toJS } from '../../utils/rules/to-js';
 
 export interface NormalizedSchema extends Schema {
   name: string;
@@ -68,7 +70,10 @@ function updateTsConfig(options: NormalizedSchema): Rule {
       }
 
       c.paths[options.importPath] = [
-        `${libsDir(host)}/${options.projectDirectory}/src/index.ts`,
+        maybeJs(
+          options,
+          `${libsDir(host)}/${options.projectDirectory}/src/index.ts`
+        ),
       ];
 
       return json;
@@ -87,6 +92,7 @@ function createFiles(options: NormalizedSchema): Rule {
         hasUnitTestRunner: options.unitTestRunner !== 'none',
       }),
       move(options.projectRoot),
+      options.js ? toJS() : noop(),
     ])
   );
 }
@@ -148,3 +154,9 @@ function normalizeOptions(host: Tree, options: Schema): NormalizedSchema {
     importPath,
   };
 }
+
+function maybeJs(options: NormalizedSchema, path: string): string {
+  return options.js && (path.endsWith('.ts') || path.endsWith('.tsx'))
+    ? path.replace(/\.tsx?$/, '.js')
+    : path;
+}
diff --git a/packages/workspace/src/schematics/library/schema.d.ts b/packages/workspace/src/schematics/library/schema.d.ts
@@ -11,4 +11,5 @@ export interface Schema {
   linter: Linter;
   testEnvironment: 'jsdom' | 'node';
   importPath?: string;
+  js?: boolean;
 }
diff --git a/packages/workspace/src/schematics/library/schema.json b/packages/workspace/src/schematics/library/schema.json
@@ -59,6 +59,11 @@
     "importPath": {
       "type": "string",
       "description": "The library name used to import it, like @myorg/my-awesome-lib"
+    },
+    "js": {
+      "type": "boolean",
+      "description": "Generate JavaScript files rather than TypeScript files",
+      "default": false
     }
   },
   "required": ["name"]

Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,5 @@ export interface Schema {`
`11`	`11`	`linter: Linter;`
`12`	`12`	`testEnvironment: 'jsdom' \| 'node';`
`13`	`13`	`importPath?: string;`
	`14`	`+ js?: boolean;`
`14`	`15`	`}`