chore(types): remove property on path normalization (#4327)

rwaskiewicz · web-flow · commit c3bcf0a1bd30 · 2023-04-28T21:34:35.000Z
this commit removes an unused property, `params`, from the return value
of `normalizeFsPathQuery`. this property does not ever appear to be
used, and was causing a handful of strictNullChecks violations in the
corresponding tests. rather than patch the tests, we remove the property
wholesale.

this commit also fixes an additional SNC violation for testing that
`normalizePath` throws when a non-string is passed as an argument to the
function
diff --git a/src/utils/normalize-path.ts b/src/utils/normalize-path.ts
@@ -168,7 +168,6 @@ export const normalizeFsPathQuery = (importPath: string) => {
   return {
     filePath,
     ext,
-    params,
     format,
   };
 };
diff --git a/src/utils/test/normalize-path.spec.ts b/src/utils/test/normalize-path.spec.ts
@@ -90,7 +90,9 @@ describe('normalizePath', () => {
 
   it('throw error when invalid string', () => {
     expect(() => {
-      const path = normalizePath(null);
+      // this test deliberately uses a value whose type does not conform to the function signature's type definition to
+      // ensure non-string's throw an error, requiring us to place a type assertion in the function call below
+      const path = normalizePath(null as unknown as string);
       expect(path).toBe(`/Johnny/B/Goode.js`);
     }).toThrow();
   });
@@ -100,33 +102,27 @@ describe('normalizeFsPathQuery', () => {
   it('format query', () => {
     const p = normalizeFsPathQuery(`/Johnny/B/Goode.js?format=text`);
     expect(p.filePath).toBe(`/Johnny/B/Goode.js`);
-    expect(p.params.get('format')).toBe('text');
     expect(p.format).toBe('text');
     expect(p.ext).toBe(`js`);
   });
 
   it('any query', () => {
     const p = normalizeFsPathQuery(`/Johnny/B/Goode.svg?a=1&b=2&c=3`);
     expect(p.filePath).toBe(`/Johnny/B/Goode.svg`);
-    expect(p.params.get('a')).toBe('1');
-    expect(p.params.get('b')).toBe('2');
-    expect(p.params.get('c')).toBe('3');
     expect(p.format).toBe(null);
     expect(p.ext).toBe(`svg`);
   });
 
   it('no query', () => {
     const p = normalizeFsPathQuery(`/Johnny/B/Goode.js`);
     expect(p.filePath).toBe(`/Johnny/B/Goode.js`);
-    expect(p.params).toBe(null);
     expect(p.format).toBe(null);
     expect(p.ext).toBe(`js`);
   });
 
   it('no ext', () => {
     const p = normalizeFsPathQuery(`/Johnny/B/Goode`);
     expect(p.filePath).toBe(`/Johnny/B/Goode`);
-    expect(p.params).toBe(null);
     expect(p.format).toBe(null);
     expect(p.ext).toBe(`/johnny/b/goode`);
   });
