Add undefined to optional properties, Karma to Mimos (DefinitelyTyped#54323)

In preparation for exactOptionalPropertyTypes in Typescript 4.4, add undefined to all optional properties. #no-publishing-comment

This PR covers widely used packages (more than 100,000 downloads per
month) from karma-chrome-launcher -- mimos
microsoft/dtslint#335

Author: sandersn

types/karma-chrome-launcher/index.d.ts

@@ -14,6 +14,6 @@ declare module 'karma' {
          * One reason to do this is to have a permanent Chrome user data directory inside the project directory
          * to be able to install plugins there (e.g. JetBrains IDE Support plugin).
          */
-        chromeDataDir?: string;
+        chromeDataDir?: string | undefined;
     }
 }

types/karma-coverage-istanbul-reporter/index.d.ts

@@ -6,56 +6,56 @@
 
 export interface Threshold {
     /** @default 0 */
-    readonly statements?: number;
+    readonly statements?: number | undefined;
 
     /** @default 0 */
-    readonly lines?: number;
+    readonly lines?: number | undefined;
 
     /** @default 0 */
-    readonly branches?: number;
+    readonly branches?: number | undefined;
 
     /** @default 0 */
-    readonly functions?: number;
+    readonly functions?: number | undefined;
 }
 
 export interface ThresholdsEach extends Threshold {
     /** @default {} */
-    readonly overrides?: { [key: string]: Threshold };
+    readonly overrides?: { [key: string]: Threshold } | undefined;
 }
 
 export interface ThresholdConfig {
     /**
      * Set to `true` to not fail the test command when thresholds are not met.
      * @default false
      */
-    readonly emitWarning?: boolean;
+    readonly emitWarning?: boolean | undefined;
 
     /** Thresholds for all files. */
-    readonly global?: Threshold;
+    readonly global?: Threshold | undefined;
 
     /** Thresholds per file. */
-    readonly each?: ThresholdsEach;
+    readonly each?: ThresholdsEach | undefined;
 }
 
 /** @see {@link https://github.com/mattlewis92/karma-coverage-istanbul-reporter#configuration} */
 export interface CoverageIstanbulReporter {
     /** Reports can be any that are listed {@link https://github.com/istanbuljs/istanbuljs/tree/aae256fb8b9a3d19414dcf069c592e88712c32c6/packages/istanbul-reports/lib here}. */
-    readonly reports?: string[];
+    readonly reports?: string[] | undefined;
 
     /**
      * Base output directory.
      * If you include `%browser%` in the path it will be replaced with the karma browser name.
      */
-    readonly dir?: string;
+    readonly dir?: string | undefined;
 
     /** Combines coverage information from multiple browsers into one report rather than outputting a report for each browser */
-    readonly combineBrowserReports?: boolean;
+    readonly combineBrowserReports?: boolean | undefined;
 
     /** if using webpack and pre-loaders, work around webpack breaking the source path. */
-    readonly fixWebpackSourcePaths?: boolean;
+    readonly fixWebpackSourcePaths?: boolean | undefined;
 
     /** Omit files with no statements, no functions and no branches from the report. */
-    readonly skipFilesWithNoCoverage?: boolean;
+    readonly skipFilesWithNoCoverage?: boolean | undefined;
 
     // TODO: Add istanbul-api
     /** Most reporters accept additional config options. You can pass these through the `report-config` option. */
@@ -65,10 +65,10 @@ export interface CoverageIstanbulReporter {
      * Enforce percentage thresholds.
      * Anything under these percentages will cause karma to fail with an exit code of 1 if not running in watch mode.
      */
-    readonly thresholds?: ThresholdConfig;
+    readonly thresholds?: ThresholdConfig | undefined;
 
     /** Output config used by istanbul for debugging. */
-    readonly verbose?: boolean;
+    readonly verbose?: boolean | undefined;
 
     // TODO: Add istanbul-api
     /** `instrumentation` is used to configure Istanbul API package. */
@@ -78,6 +78,6 @@ export interface CoverageIstanbulReporter {
 declare module 'karma' {
     interface ConfigOptions {
         /** {@link https://github.com/istanbuljs/istanbuljs/blob/aae256fb8b9a3d19414dcf069c592e88712c32c6/packages/istanbul-api/lib/config.js#L33-L39 Any of these options are valid}. */
-        readonly coverageIstanbulReporter?: CoverageIstanbulReporter;
+        readonly coverageIstanbulReporter?: CoverageIstanbulReporter | undefined;
     }
 }

types/karma-coverage/index.d.ts

@@ -13,7 +13,7 @@ declare module "karma" {
         /**
          * {@link https://github.com/karma-runner/karma-coverage/blob/v1.1.2/docs/configuration.md }
          */
-        coverageReporter?: KarmaCoverageReporter & { reporters?: KarmaCoverageReporter[] };
+        coverageReporter?: KarmaCoverageReporter & { reporters?: KarmaCoverageReporter[] | undefined } | undefined;
     }
 
     /** Reporter type */
@@ -32,80 +32,80 @@ declare module "karma" {
 
     interface Reporter {
         type: ReporterType;
-        dir?: string;
-        subdir?: string | ((browser: string) => string);
-        file?: string;
+        dir?: string | undefined;
+        subdir?: string | ((browser: string) => string) | undefined;
+        file?: string | undefined;
     }
 
     interface CheckTresholds {
-        global?: Tresholds;
-        each?: Tresholds;
+        global?: Tresholds | undefined;
+        each?: Tresholds | undefined;
     }
 
     interface Tresholds {
-        statements?: number;
-        branches?: number;
-        functions?: number;
-        lines?: number;
-        excludes?: string[];
-        overrides?: Record<string, Tresholds>;
+        statements?: number | undefined;
+        branches?: number | undefined;
+        functions?: number | undefined;
+        lines?: number | undefined;
+        excludes?: string[] | undefined;
+        overrides?: Record<string, Tresholds> | undefined;
     }
 
     interface Watermarks {
-        statements?: [number, number];
-        functions?: [number, number];
-        branches?: [number, number];
-        lines?: [number, number];
+        statements?: [number, number] | undefined;
+        functions?: [number, number] | undefined;
+        branches?: [number, number] | undefined;
+        lines?: [number, number] | undefined;
     }
 
     interface KarmaCoverageReporter {
         /** Specify a reporter type */
-        type?: ReporterType;
+        type?: ReporterType | undefined;
 
         /** This will be used to output coverage reports. When you set a relative path, the directory is resolved against the basePath. */
-        dir?: string;
+        dir?: string | undefined;
 
         /** This will be used in complement of the coverageReporter.dir option to generate the full output directory path */
-        subdir?: string | ((browser: string) => string);
+        subdir?: string | ((browser: string) => string) | undefined;
 
         /** If you use one of these reporters, `cobertura`, `lcovonly`, `teamcity`, `text` or `text-summary`, you may set the file option to specify the output file */
-        file?: string;
+        file?: string | undefined;
 
         /** This will be used to configure minimum threshold enforcement for coverage results */
-        check?: CheckTresholds;
+        check?: CheckTresholds | undefined;
 
         /** This will be used to set the coverage threshold colors */
-        watermarks?: Watermarks;
+        watermarks?: Watermarks | undefined;
         /**
          * You can opt to include all sources files, as indicated by the coverage preprocessor,
          * in your code coverage data, even if there are no tests covering them
          */
-        includeAllSources?: boolean;
+        includeAllSources?: boolean | undefined;
 
         /** You can opt to specify a source store allowing for external coverage collectors access to the instrumented code. */
-        sourceStore?: Store;
+        sourceStore?: Store | undefined;
 
         /** You can use multiple reporters, by providing array of options */
-        reporters?: Reporter[];
+        reporters?: Reporter[] | undefined;
         /**
          * Karma-coverage can infers the instrumenter regarding of the file extension.
          * It is possible to override this behavior and point out an instrumenter
          * for the files matching a specific pattern.
          */
         instrumenter?: {
             [key: string]: string;
-        };
+        } | undefined;
 
-        instrumenters?: Record<string, any>;
+        instrumenters?: Record<string, any> | undefined;
 
-        instrumenterOptions?: Record<string, Record<string, unknown>>;
+        instrumenterOptions?: Record<string, Record<string, unknown>> | undefined;
 
         /**
          * If set to true, then CoffeeScript files instrumented with Ibrik will use
          * the .js extension for the transpiled source (without this option,
          * the JavaScript files will keep the original .coffee extension)
          */
-        useJSExtensionForCoffeeScript?: boolean;
+        useJSExtensionForCoffeeScript?: boolean | undefined;
 
         [moreSettings: string]: unknown;
     }

types/karma-jasmine-html-reporter/index.d.ts

@@ -13,14 +13,14 @@ declare module 'karma' {
          * because it's already handled by another reporter
          * See {@link https://github.com/dfederm/karma-jasmine-html-reporter#with-options}
          */
-        jasmineHtmlReporter?: JasmineHtmlReporterOptions;
+        jasmineHtmlReporter?: JasmineHtmlReporterOptions | undefined;
     }
     interface JasmineHtmlReporterOptions {
         /**
          * Suppress all messages (overrides other suppress settings)
          */
-        suppressAll?: boolean;
+        suppressAll?: boolean | undefined;
         /** Suppress failed messages */
-        suppressFailed?: boolean;
+        suppressFailed?: boolean | undefined;
     }
 }

types/karma-jasmine/index.d.ts

@@ -12,22 +12,22 @@ declare module 'karma' {
     interface ClientOptions {
         jasmine?: jasmine.EnvConfiguration & {
             /** @deprecated undocumented to be removed */
-            timeoutInterval?: number;
-        };
+            timeoutInterval?: number | undefined;
+        } | undefined;
         /**
          * run a subset of the full set of specs.
          * Complete sharding support needs to be done in the process that calls karma,
          * and would need to support test result integration across shards.
          * See {@link https://github.com/karma-runner/karma-jasmine#sharding}
          *
          */
-        shardIndex?: number;
+        shardIndex?: number | undefined;
         /**
          * run a subset of the full set of specs.
          * Complete sharding support needs to be done in the process that calls karma,
          * and would need to support test result integration across shards.
          * See {@link https://github.com/karma-runner/karma-jasmine#sharding}
          */
-        totalShards?: number;
+        totalShards?: number | undefined;
     }
 }