fix: fix #2011 (#2013)

Turn on `exactOptionalPropertyTypes` for types.
streetsidesoftware · Nov 24, 2021 · 15abecb · 15abecb
1 parent 663cc99
commit 15abecb
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 9 deletions.
diff --git a/packages/cspell-glob/src/GlobMatcher.ts b/packages/cspell-glob/src/GlobMatcher.ts
@@ -5,7 +5,11 @@ import { PathInterface, GlobMatch, GlobPattern, GlobPatternWithRoot } from './Gl
 
 // cspell:ignore fname
 
-export type GlobMatchOptions = Partial<NormalizedGlobMatchOptions>;
+type Optional<T> = {
+    [P in keyof T]?: T[P] | undefined;
+};
+
+export type GlobMatchOptions = Optional<NormalizedGlobMatchOptions>;
 
 export type MatcherMode = 'exclude' | 'include';
 
@@ -59,7 +63,7 @@ interface NormalizedGlobMatchOptions {
      *
      * @default false
      */
-    nobrace?: boolean; // cspell:ignore nobrace
+    nobrace?: boolean | undefined; // cspell:ignore nobrace
 }
 
 export class GlobMatcher {

diff --git a/packages/cspell-glob/src/GlobMatcherTypes.ts b/packages/cspell-glob/src/GlobMatcherTypes.ts
@@ -37,15 +37,15 @@ export interface GlobPatternWithOptionalRoot {
      * The root from which the glob pattern is relative.
      * @default: options.root
      */
-    root?: string;
+    root?: string | undefined;
     /**
      * Optional value useful for tracing which file a glob pattern was defined in.
      */
-    source?: string;
+    source?: string | undefined;
     /**
      * Optional line number in the source
      */
-    line?: number;
+    line?: number | undefined;
 }
 
 export interface GlobPatternWithRoot extends GlobPatternWithOptionalRoot {

diff --git a/packages/cspell-glob/src/globHelper.ts b/packages/cspell-glob/src/globHelper.ts
@@ -24,7 +24,8 @@ export function fileOrGlobToGlob(
     const pathToGlob = path.sep === '\\' ? (p: string) => p.replace(/\\/g, '/') : (p: string) => p;
 
     if (typeof fileOrGlob !== 'string') {
-        return { root, ...fileOrGlob };
+        const useRoot = fileOrGlob.root ?? root;
+        return { ...fileOrGlob, root: useRoot };
     }
 
     if (doesRootContainPath(root, fileOrGlob, path) || relRegExp.test(fileOrGlob)) {

diff --git a/packages/cspell-grammar/tsconfig.json b/packages/cspell-grammar/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "outDir": "dist"
     },
     "include": [

diff --git a/packages/cspell-lib/tsconfig.json b/packages/cspell-lib/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "strictFunctionTypes": false,
         "outDir": "dist"
     },

diff --git a/packages/cspell-tools/tsconfig.json b/packages/cspell-tools/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "outDir": "dist"
     },
     "include": [

diff --git a/packages/cspell-trie-lib/tsconfig.json b/packages/cspell-trie-lib/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "outDir": "dist"
     },
     "include": [

diff --git a/packages/cspell-types/src/CSpellSettingsDef.ts b/packages/cspell-types/src/CSpellSettingsDef.ts
@@ -741,11 +741,11 @@ interface BaseSource {
     /** name of source */
     name: string;
     /** filename if this came from a file. */
-    filename?: string;
+    filename?: string | undefined;
     /** The two settings that were merged to */
-    sources?: [CSpellSettings] | [CSpellSettings, CSpellSettings];
+    sources?: [CSpellSettings] | [CSpellSettings, CSpellSettings] | undefined;
     /** The configuration read. */
-    fileSource?: CSpellSettings;
+    fileSource?: CSpellSettings | undefined;
 }
 
 /**

diff --git a/packages/cspell/tsconfig.json b/packages/cspell/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "outDir": "dist"
     },
     "include": [

diff --git a/packages/hunspell-reader/tsconfig.json b/packages/hunspell-reader/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "exactOptionalPropertyTypes": false, // make this true
         "noImplicitAny": false,
         "outDir": "dist"
     },

diff --git a/tsconfig.json b/tsconfig.json
@@ -7,6 +7,7 @@
         "declaration": true,
         "declarationMap": true,
         "esModuleInterop": true,
+        "exactOptionalPropertyTypes": true,
         "moduleResolution": "node",
         "newLine": "LF",
         "noImplicitAny": true,