chore(types): fix some strictNullChecks errors (#3932)

alicewriteswrongs · rwaskiewicz · commit ee92c95ef84d · 2023-01-25T09:56:11.000-05:00
This just fixes a few strictNullChecks errors, selected just by running
the TypeScript compiler with the option turned on and fixing a few
errors that popped up.
diff --git a/src/cli/run.ts b/src/cli/run.ts
@@ -129,14 +129,17 @@ export const runTask = async (
   sys?: d.CompilerSystem
 ): Promise<void> => {
   const logger = config.logger ?? createLogger();
+  const rootDir = config.rootDir ?? '/';
+  const configSys = sys ?? config.sys ?? coreCompiler.createSystem({ logger });
   const strictConfig: ValidatedConfig = {
     ...config,
     flags: createConfigFlags(config.flags ?? { task }),
     hydratedFlag: config.hydratedFlag ?? null,
     logger,
     outputTargets: config.outputTargets ?? [],
-    rootDir: config.rootDir ?? '/',
-    sys: sys ?? config.sys ?? coreCompiler.createSystem({ logger }),
+    packageJsonFilePath: configSys.platformPath.join(rootDir, 'package.json'),
+    rootDir,
+    sys: configSys,
     testing: config.testing ?? {},
   };
 
diff --git a/src/compiler/build/build-stats.ts b/src/compiler/build/build-stats.ts
@@ -64,8 +64,9 @@ export function generateBuildStats(
     }
   } catch (e: unknown) {
     const diagnostic: d.Diagnostic = {
-      messageText: `Generate Build Stats Error: ` + e,
       level: `error`,
+      lines: [],
+      messageText: `Generate Build Stats Error: ` + e,
       type: `build`,
     };
     jsonData = {
diff --git a/src/compiler/build/test/build-stats.spec.ts b/src/compiler/build/test/build-stats.spec.ts
@@ -55,6 +55,7 @@ describe('generateBuildStats', () => {
       level: 'error',
       type: 'horrible',
       messageText: 'the worst error _possible_ has just occurred',
+      lines: [],
     };
     buildCtx.buildResults.diagnostics = [diagnostic];
     const result = generateBuildStats(config, buildCtx);
diff --git a/src/compiler/config/test/load-config.spec.ts b/src/compiler/config/test/load-config.spec.ts
@@ -82,13 +82,15 @@ describe('load config', () => {
       expect<d.Diagnostic>(loadedConfig.diagnostics[0]).toEqual({
         absFilePath: '/tsconfig.json',
         code: '18003',
+        columnNumber: undefined,
         header: 'TypeScript',
         language: 'typescript',
         level: 'warn',
+        lineNumber: undefined,
         lines: [],
         messageText:
           "No inputs were found in config file '/tsconfig.json'. Specified 'include' paths were '[\"src\"]' and 'exclude' paths were '[]'.",
-        relFilePath: null,
+        relFilePath: undefined,
         type: 'typescript',
       });
     });
diff --git a/src/compiler/config/test/validate-service-worker.spec.ts b/src/compiler/config/test/validate-service-worker.spec.ts
@@ -12,14 +12,15 @@ describe('validateServiceWorker', () => {
 
   beforeEach(() => {
     config = {
-      fsNamespace: 'app',
-      rootDir: '/',
-      hydratedFlag: null,
-      sys: mockCompilerSystem(),
       devMode: false,
       flags: createConfigFlags(),
+      fsNamespace: 'app',
+      hydratedFlag: null,
       logger: mockLogger(),
       outputTargets: [],
+      packageJsonFilePath: '/package.json',
+      rootDir: '/',
+      sys: mockCompilerSystem(),
       testing: {},
     };
   });
diff --git a/src/compiler/config/validate-config.ts b/src/compiler/config/validate-config.ts
@@ -1,4 +1,5 @@
 import { buildError, isBoolean, isNumber, isString, sortBy } from '@utils';
+import { join } from 'path';
 
 import { ConfigBundle, Diagnostic, LoadConfigInit, UnvalidatedConfig, ValidatedConfig } from '../../declarations';
 import { createLogger } from '../sys/logger/console-logger';
@@ -47,6 +48,7 @@ export const validateConfig = (
   const diagnostics: Diagnostic[] = [];
 
   const logger = bootstrapConfig.logger || config.logger || createLogger();
+  const rootDir = typeof config.rootDir === 'string' ? config.rootDir : '/';
 
   const validatedConfig: ValidatedConfig = {
     ...config,
@@ -55,7 +57,8 @@ export const validateConfig = (
     hydratedFlag: validateHydrated(config),
     logger,
     outputTargets: config.outputTargets ?? [],
-    rootDir: typeof config.rootDir === 'string' ? config.rootDir : '/',
+    packageJsonFilePath: join(rootDir, 'package.json'),
+    rootDir,
     sys: config.sys ?? bootstrapConfig.sys ?? createSystem({ logger }),
     testing: config.testing ?? {},
   };
diff --git a/src/compiler/html/remove-unused-styles.ts b/src/compiler/html/remove-unused-styles.ts
@@ -50,6 +50,7 @@ const removeUnusedStyleText = (
         type: 'css',
         header: 'CSS Stringify',
         messageText: e,
+        lines: [],
       });
     }
   } catch (e: any) {
@@ -58,6 +59,7 @@ const removeUnusedStyleText = (
       type: 'css',
       header: 'CSS Parse',
       messageText: e,
+      lines: [],
     });
   }
 };
diff --git a/src/compiler/optimize/autoprefixer.ts b/src/compiler/optimize/autoprefixer.ts
@@ -38,6 +38,7 @@ export const autoprefixCss = async (cssText: string, opts: boolean | null | d.Au
         messageText: warning.text,
         level: 'warn',
         type: 'css',
+        lines: [],
       });
     });
 
@@ -48,6 +49,7 @@ export const autoprefixCss = async (cssText: string, opts: boolean | null | d.Au
       messageText: `CSS Error` + e,
       level: `error`,
       type: `css`,
+      lines: [],
     };
 
     if (typeof e.name === 'string') {
diff --git a/src/compiler/output-targets/dist-custom-elements/index.ts b/src/compiler/output-targets/dist-custom-elements/index.ts
@@ -135,6 +135,7 @@ export const bundleCustomElements = async (
           level: 'error',
           type: 'build',
           messageText: 'dist-custom-elements output target provided with no output target directory!',
+          lines: [],
         });
         return;
       }
diff --git a/src/compiler/output-targets/test/output-targets-dist-custom-elements.spec.ts b/src/compiler/output-targets/test/output-targets-dist-custom-elements.spec.ts
@@ -130,6 +130,7 @@ export * from '${USER_INDEX_ENTRY_ID}';
       expect(buildCtx.diagnostics).toEqual([
         {
           level: 'error',
+          lines: [],
           type: 'build',
           messageText: 'dist-custom-elements output target provided with no output target directory!',
         },
diff --git a/src/compiler/sys/config.ts b/src/compiler/sys/config.ts
@@ -1,3 +1,5 @@
+import { join } from 'path';
+
 import { createConfigFlags } from '../../cli/config-flags';
 import type * as d from '../../declarations';
 import { setPlatformPath } from '../sys/modules/path';
@@ -6,13 +8,15 @@ import { createSystem } from './stencil-sys';
 
 export const getConfig = (userConfig: d.Config): d.ValidatedConfig => {
   const logger = userConfig.logger ?? createLogger();
+  const rootDir = userConfig.rootDir ?? '/';
   const config: d.ValidatedConfig = {
     ...userConfig,
     flags: createConfigFlags(userConfig.flags ?? {}),
     hydratedFlag: userConfig.hydratedFlag ?? null,
     logger,
     outputTargets: userConfig.outputTargets ?? [],
-    rootDir: userConfig.rootDir ?? '/',
+    packageJsonFilePath: join(rootDir, 'package.json'),
+    rootDir,
     sys: userConfig.sys ?? createSystem({ logger }),
     testing: userConfig ?? {},
   };
diff --git a/src/declarations/stencil-public-compiler.ts b/src/declarations/stencil-public-compiler.ts
@@ -1,5 +1,5 @@
 import type { ConfigFlags } from '../cli/config-flags';
-import type { PrerenderUrlResults } from '../internal';
+import type { PrerenderUrlResults, PrintLine } from '../internal';
 import type { JsonDocs } from './stencil-public-docs';
 
 export * from './stencil-public-docs';
@@ -424,7 +424,15 @@ type RequireFields<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 /**
  * Fields in {@link Config} to make required for {@link ValidatedConfig}
  */
-type StrictConfigFields = 'flags' | 'hydratedFlag' | 'logger' | 'outputTargets' | 'rootDir' | 'sys' | 'testing';
+type StrictConfigFields =
+  | 'flags'
+  | 'hydratedFlag'
+  | 'logger'
+  | 'outputTargets'
+  | 'packageJsonFilePath'
+  | 'rootDir'
+  | 'sys'
+  | 'testing';
 
 /**
  * A version of {@link Config} that makes certain fields required. This type represents a valid configuration entity.
@@ -2288,24 +2296,18 @@ export interface LoadConfigResults {
 }
 
 export interface Diagnostic {
-  level: 'error' | 'warn' | 'info' | 'log' | 'debug';
-  type: string;
+  absFilePath?: string | undefined;
+  code?: string;
+  columnNumber?: number | undefined;
+  debugText?: string;
   header?: string;
   language?: string;
+  level: 'error' | 'warn' | 'info' | 'log' | 'debug';
+  lineNumber?: number | undefined;
+  lines: PrintLine[];
   messageText: string;
-  debugText?: string;
-  code?: string;
-  absFilePath?: string;
-  relFilePath?: string;
-  lineNumber?: number;
-  columnNumber?: number;
-  lines?: {
-    lineIndex: number;
-    lineNumber: number;
-    text?: string;
-    errorCharStart: number;
-    errorLength?: number;
-  }[];
+  relFilePath?: string | undefined;
+  type: string;
 }
 
 export interface CacheStorage {
diff --git a/src/dev-server/ssr-request.ts b/src/dev-server/ssr-request.ts
@@ -137,15 +137,16 @@ async function setupHydrateApp(devServerConfig: d.DevServerConfig, serverCtx: d.
   }
 
   if (!isString(buildResults.hydrateAppFilePath)) {
-    diagnostics.push({ messageText: `Missing hydrateAppFilePath`, level: `error`, type: `ssr` });
+    diagnostics.push({ messageText: `Missing hydrateAppFilePath`, level: `error`, type: `ssr`, lines: [] });
   } else if (!isString(devServerConfig.srcIndexHtml)) {
-    diagnostics.push({ messageText: `Missing srcIndexHtml`, level: `error`, type: `ssr` });
+    diagnostics.push({ messageText: `Missing srcIndexHtml`, level: `error`, type: `ssr`, lines: [] });
   } else {
     srcIndexHtml = await serverCtx.sys.readFile(devServerConfig.srcIndexHtml);
     if (!isString(srcIndexHtml)) {
       diagnostics.push({
-        messageText: `Unable to load src index html: ${devServerConfig.srcIndexHtml}`,
         level: `error`,
+        lines: [],
+        messageText: `Unable to load src index html: ${devServerConfig.srcIndexHtml}`,
         type: `ssr`,
       });
     } else {
diff --git a/src/testing/mocks.ts b/src/testing/mocks.ts
@@ -30,14 +30,16 @@ import { createTestingSystem, TestingSystem } from './testing-sys';
  */
 export function mockValidatedConfig(overrides: Partial<ValidatedConfig> = {}): ValidatedConfig {
   const baseConfig = mockConfig(overrides);
+  const rootDir = path.resolve('/');
 
   return {
     ...baseConfig,
     flags: createConfigFlags(),
     hydratedFlag: null,
     logger: mockLogger(),
     outputTargets: baseConfig.outputTargets ?? [],
-    rootDir: path.resolve('/'),
+    packageJsonFilePath: path.join(rootDir, 'package.json'),
+    rootDir,
     sys: createTestingSystem(),
     testing: {},
     ...overrides,
diff --git a/src/utils/logger/logger-typescript.ts b/src/utils/logger/logger-typescript.ts
@@ -102,22 +102,24 @@ export const loadTypeScriptDiagnostics = (tsDiagnostics: readonly Diagnostic[])
  */
 export const loadTypeScriptDiagnostic = (tsDiagnostic: Diagnostic): d.Diagnostic => {
   const d: d.Diagnostic = {
-    level: 'warn',
-    type: 'typescript',
-    language: 'typescript',
-    header: 'TypeScript',
+    absFilePath: undefined,
     code: tsDiagnostic.code.toString(),
-    messageText: flattenDiagnosticMessageText(tsDiagnostic, tsDiagnostic.messageText),
-    relFilePath: null,
-    absFilePath: null,
+    columnNumber: undefined,
+    header: 'TypeScript',
+    language: 'typescript',
+    level: 'warn',
+    lineNumber: undefined,
     lines: [],
+    messageText: flattenDiagnosticMessageText(tsDiagnostic, tsDiagnostic.messageText),
+    relFilePath: undefined,
+    type: 'typescript',
   };
 
   if (tsDiagnostic.category === 1) {
     d.level = 'error';
   }
 
-  if (tsDiagnostic.file) {
+  if (tsDiagnostic.file && typeof tsDiagnostic.start === 'number') {
     d.absFilePath = tsDiagnostic.file.fileName;
 
     const sourceText = tsDiagnostic.file.text;
@@ -130,7 +132,7 @@ export const loadTypeScriptDiagnostic = (tsDiagnostic: Diagnostic): d.Diagnostic
       lineNumber: posData.line + 1,
       text: srcLines[posData.line],
       errorCharStart: posData.character,
-      errorLength: Math.max(tsDiagnostic.length, 1),
+      errorLength: Math.max(tsDiagnostic.length ?? 0, 1),
     };
 
     d.lineNumber = errorLine.lineNumber;
diff --git a/src/utils/test/util.spec.ts b/src/utils/test/util.spec.ts
@@ -170,24 +170,6 @@ describe('util', () => {
       });
     });
 
-    it('returns a parse error if parsing cannot complete for undefined package path', () => {
-      // improperly formatted JSON - note the lack of ':'
-      const diagnostic = util.parsePackageJson('{ "someJson" "value"}', undefined);
-
-      const expectedDiagnostic: d.Diagnostic = stubDiagnostic({
-        absFilePath: undefined,
-        header: 'Error Parsing JSON',
-        messageText: 'Unexpected string in JSON at position 13', // due to missing colon in input
-        type: 'build',
-      });
-
-      expect(diagnostic).toEqual<util.ParsePackageJsonResult>({
-        diagnostic: expectedDiagnostic,
-        data: null,
-        filePath: undefined,
-      });
-    });
-
     it('returns the parsed data from the provided json', () => {
       const diagnostic = util.parsePackageJson('{ "someJson": "value"}', mockPackageJsonPath);
 

Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ export const bundleCustomElements = async (`
`135`	`135`	`level: 'error',`
`136`	`136`	`type: 'build',`
`137`	`137`	`messageText: 'dist-custom-elements output target provided with no output target directory!',`
	`138`	`+ lines: [],`
`138`	`139`	`});`
`139`	`140`	`return;`
`140`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,7 @@ export * from '${USER_INDEX_ENTRY_ID}';`
`130`	`130`	`expect(buildCtx.diagnostics).toEqual([`
`131`	`131`	`{`
`132`	`132`	`level: 'error',`
	`133`	`+ lines: [],`
`133`	`134`	`type: 'build',`
`134`	`135`	`messageText: 'dist-custom-elements output target provided with no output target directory!',`
`135`	`136`	`},`