refactor(sdk/e2e-schematics): e2e-schematics strict mode support (#497)

Author: Blackbaud-TrevorBurch

libs/sdk/e2e-schematics/src/generators/component-e2e/index.spec.ts

@@ -52,7 +52,7 @@ describe('component-e2e', () => {
     expect(
       tree
         .read(`${config['test-storybook-e2e'].sourceRoot}/support/index.ts`)
-        .toString()
+        ?.toString()
     ).toContain('percy');
   });
 

libs/sdk/e2e-schematics/src/generators/component-e2e/index.ts

@@ -84,6 +84,12 @@ export default async function (tree: Tree, schema: Partial<Schema>) {
 
     // Delete boilerplate files from the storybook project.
     let indexFile = tree.read(`${projectConfig.sourceRoot}/index.html`, 'utf8');
+
+    // istanbul ignore if
+    if (!indexFile) {
+      indexFile = '';
+    }
+
     indexFile = indexFile.replace(
       '<link rel="icon" type="image/x-icon" href="favicon.ico" />',
       ''

libs/sdk/e2e-schematics/src/generators/configure-percy/index.spec.ts

@@ -14,12 +14,14 @@ describe('configure-percy', () => {
     });
     expect(tree.exists('apps/cypress/src/support/index.ts')).toBeTruthy();
     expect(
-      tree.read('apps/cypress/src/support/index.ts').toString()
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      tree.read('apps/cypress/src/support/index.ts')!.toString()
     ).not.toContain('percy');
     await configurePercy(tree, { name: 'cypress' });
-    expect(tree.read('apps/cypress/src/support/index.ts').toString()).toContain(
-      'percy'
-    );
+    expect(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      tree.read('apps/cypress/src/support/index.ts')!.toString()
+    ).toContain('percy');
   });
 
   it('should not make changes without cypress.json', async () => {
@@ -50,7 +52,8 @@ describe('configure-percy', () => {
     );
     await configurePercy(tree, { name: 'cypress' });
     const config = JSON.parse(
-      tree.read(`apps/cypress/cypress.json`).toString()
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      tree.read(`apps/cypress/cypress.json`)!.toString()
     );
     expect(config.video).toBeFalsy();
   });

libs/sdk/e2e-schematics/src/generators/configure-percy/index.ts

@@ -36,7 +36,8 @@ export default async function (tree: Tree, schema: Schema) {
         if (!tree.isFile(filePath)) {
           tree.write(filePath, importPercyCypress);
         } else {
-          const content = tree.read(filePath).toString();
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          const content = tree.read(filePath)!.toString();
           if (!content.includes(importPercyCypress)) {
             insertStatement(tree, filePath, importPercyCypress);
           }

libs/sdk/e2e-schematics/src/generators/configure-storybook/index.spec.ts

@@ -28,26 +28,30 @@ describe('configure-storybook', () => {
     expect(tree.exists(`apps/test-app/.storybook/preview.js`)).toBeFalsy();
     expect(tree.exists(`apps/test-app/.storybook/preview.ts`)).toBeTruthy();
     const e2eConfig = readProjectConfiguration(tree, `test-app-e2e`);
-    expect(e2eConfig.targets.e2e.options.devServerTarget).toEqual(
+    expect(e2eConfig.targets?.e2e.options.devServerTarget).toEqual(
       `test-app:storybook`
     );
-    expect(e2eConfig.targets.e2e.configurations.ci.skipServe).toBeTruthy();
-    updateJson(tree, getWorkspacePath(tree), (json) => {
-      delete json['projects']['test-app'].architect.build.options;
+    expect(e2eConfig.targets?.e2e.configurations?.ci.skipServe).toBeTruthy();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    updateJson(tree, getWorkspacePath(tree)!, (json) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      delete (json as any)['projects']['test-app'].architect.build.options;
       return json;
     });
     await configureStorybook(tree, { name: 'test-app' });
     expect(
-      readProjectConfiguration(tree, `test-app`).targets.build.options.styles
+      readProjectConfiguration(tree, `test-app`).targets?.build.options.styles
         .length
     ).toBeGreaterThan(0);
-    updateJson(tree, getWorkspacePath(tree), (json) => {
-      json['projects']['test-app'].architect.build.options = {};
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    updateJson(tree, getWorkspacePath(tree)!, (json) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (json as any)['projects']['test-app'].architect.build.options = {};
       return json;
     });
     await configureStorybook(tree, { name: 'test-app' });
     expect(
-      readProjectConfiguration(tree, `test-app`).targets.build.options.styles
+      readProjectConfiguration(tree, `test-app`).targets?.build.options.styles
         .length
     ).toBeGreaterThan(0);
   });
@@ -90,8 +94,11 @@ describe('configure-storybook', () => {
     await configureStorybook(tree, { name: 'test-app' });
     expect(tree.exists(`apps/test-app/.storybook/tsconfig.json`)).toBeTruthy();
     expect(
-      JSON.parse(tree.read(`apps/test-app/.storybook/tsconfig.json`).toString())
-        .include
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      JSON.parse(
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        tree.read(`apps/test-app/.storybook/tsconfig.json`)!.toString()
+      ).include
     ).toBeTruthy();
   });
 
@@ -116,7 +123,8 @@ describe('configure-storybook', () => {
     await configureStorybook(tree, { name: 'test-app' });
     await configureStorybook(tree, { name: 'test-app', ansiColor: false });
     const e2eConfig = readProjectConfiguration(tree, `test-app-e2e`);
-    expect(e2eConfig.targets.e2e).toBeFalsy();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    expect(e2eConfig.targets!.e2e).toBeFalsy();
     expect(errorSpy).toHaveBeenCalledWith(
       `Project "test-app-e2e" does not have an e2e target with @nrwl/cypress:cypress`
     );

libs/sdk/e2e-schematics/src/generators/configure-storybook/index.ts

@@ -21,6 +21,12 @@ import { Schema } from './schema';
 export default async function (tree: Tree, schema: Schema) {
   const projects = getStorybookProjects(tree, schema.name);
   const workspacePath = getWorkspacePath(tree);
+
+  // istanbul ignore if
+  if (!workspacePath) {
+    throw new Error(`Unable to determine workspace file path`);
+  }
+
   projects.forEach((project, projectName) => {
     updateJson(tree, workspacePath, (angularJson) => {
       const targets = Object.keys(angularJson.projects[projectName].architect);

libs/sdk/e2e-schematics/src/generators/init/index.spec.ts

@@ -26,26 +26,33 @@ describe('init generator', () => {
     });
     await generator(appTree, { ansiColor: false });
     const config = readProjectConfiguration(appTree, 'storybook');
-    expect(config.targets.storybook).toBeDefined();
+    expect(config.targets?.storybook).toBeDefined();
     expect(
       appTree.isFile(
         joinPathFragments(
-          config.sourceRoot,
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          config.sourceRoot!,
           'lib/preview-wrapper/preview-wrapper-decorators.ts'
         )
       )
     ).toBeTruthy();
     expect(
-      appTree.read(joinPathFragments(config.sourceRoot, 'index.ts'), 'utf-8')
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      appTree.read(joinPathFragments(config.sourceRoot!, 'index.ts'), 'utf-8')
     ).toMatchSnapshot();
   });
 
   it('should error without a "storybook" project', async () => {
     try {
       await generator(appTree, { ansiColor: false });
-      fail();
+      fail('should have thrown');
     } catch (e) {
-      expect(e.message).toEqual('Storybook project not found');
+      if (!(e instanceof Error)) {
+        fail('should have thrown an error');
+      }
+      expect(e.message).toBe(
+        'Storybook project or storybook project information not found'
+      );
     }
   });
 

libs/sdk/e2e-schematics/src/generators/init/index.ts

@@ -26,8 +26,12 @@ import { Schema } from './schema';
  */
 export default async function (tree: Tree, options: Schema) {
   const storybookConfig = getProjects(tree).get('storybook');
-  if (!storybookConfig) {
-    throw new Error('Storybook project not found');
+  if (
+    !(storybookConfig && storybookConfig.targets && storybookConfig.sourceRoot)
+  ) {
+    throw new Error(
+      'Storybook project or storybook project information not found'
+    );
   }
   if (!storybookConfig.targets.storybook) {
     // nx g @nrwl/angular:storybook-configuration storybook --no-configureCypress --no-generateStories --no-generateCypressSpecs

libs/sdk/e2e-schematics/src/generators/stories/index.spec.ts

@@ -41,6 +41,28 @@ describe('stories generator', () => {
     ).toMatchSnapshot();
   });
 
+  it('should error if a project name is not given', async () => {
+    await applicationGenerator(appTree, {
+      name: 'test',
+    });
+    await storybookConfigurationGenerator(appTree, {
+      name: 'test',
+      generateCypressSpecs: false,
+      configureCypress: true,
+      linter: Linter.None,
+      generateStories: false,
+    });
+    options.project = undefined;
+    try {
+      await storiesGenerator(appTree, options);
+    } catch (e) {
+      if (!(e instanceof Error)) {
+        fail('should have thrown error');
+      }
+      expect(e.message).toBe('Project name not specified');
+    }
+  });
+
   it('should generate folder path', async () => {
     await applicationGenerator(appTree, {
       name: 'test',

libs/sdk/e2e-schematics/src/generators/stories/index.ts

@@ -49,15 +49,28 @@ function normalizeOptions(
   tree: Tree,
   options: StoriesGeneratorSchema
 ): NormalizedSchema {
+  if (!options.project) {
+    throw new Error('Project name not specified');
+  }
+
   const projects = getProjects(tree);
   const projectConfig = getStorybookProject(tree, options);
-  const projectDirectory = projectConfig.sourceRoot;
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const projectDirectory = projectConfig.sourceRoot!;
   const projectName = options.project;
   const projectRoot = projectConfig.root;
   const e2eProjectConfig = projects.get(
     options.cypressProject || `${projectName}-e2e`
   );
-  const e2eSourceRoot = e2eProjectConfig.sourceRoot;
+
+  let e2eSourceRoot: string | undefined;
+
+  // istanbul ignore else
+  if (e2eProjectConfig) {
+    e2eSourceRoot = e2eProjectConfig.sourceRoot;
+  } else {
+    e2eSourceRoot = undefined;
+  }
 
   return {
     ...options,
@@ -135,9 +148,11 @@ export default async function (tree: Tree, options: StoriesGeneratorSchema) {
 
       // Look for a directory to group this story in
       const paths = filepath
-        .substring(normalizedOptions.projectConfig.sourceRoot.length + 1)
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        .substring(normalizedOptions.projectConfig.sourceRoot!.length + 1)
         .split('/');
-      const filename = paths.pop();
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const filename = paths.pop()!;
       let componentGroup = '';
       for (let i = paths.length - 1; i >= 0; i--) {
         // Skip directory with the same name as the component or a set of generic names.
@@ -180,7 +195,8 @@ export default async function (tree: Tree, options: StoriesGeneratorSchema) {
         normalizedOptions.projectDirectory,
         componentFilePath
       );
-      if (module && module.module.classDeclaration.name.text) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      if (module && module.module.classDeclaration.name!.text) {
         let importPath = normalizePath(
           relative(
             filepath.substring(0, filepath.lastIndexOf('/')),
@@ -191,13 +207,15 @@ export default async function (tree: Tree, options: StoriesGeneratorSchema) {
           importPath = `./${importPath}`;
         }
         const moduleImportTransformer = getInsertImportTransformer(
-          module.module.classDeclaration.name.text,
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          module.module.classDeclaration.name!.text,
           importPath
         );
         const moduleMetadataImportsTransformer =
           getInsertIdentifierToArrayTransformer(
             'imports',
-            module.module.classDeclaration.name.text
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            module.module.classDeclaration.name!.text
           );
         applyTransformersToPath(tree, filepath, [
           moduleImportTransformer,
@@ -235,11 +253,13 @@ export default async function (tree: Tree, options: StoriesGeneratorSchema) {
           tree.delete(filepath);
           return;
         }
-        let spec = tree.read(filepath, 'utf8');
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        let spec = tree.read(filepath, 'utf8')!;
         const visitIdMatch = spec.match(matchCypressVisitId);
         if (visitIdMatch) {
           const id = visitIdMatch[1];
-          spec = spec
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          spec = spec!
             // Inject the theme in the url and use the updated id
             .replace(
               matchCypressVisitId,