Merge pull request #199 from snyk/fix/error-handle-invalid-dot-snyk

fix: descriptive error when .snyk contains invalid ignores
snyk · Aug 4, 2023 · b1f6dea · b1f6dea
2 parents 282ef8f + 370e654
commit b1f6dea
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/src/files.ts b/src/files.ts
@@ -129,7 +129,12 @@ export function parseFileIgnores(path: string): string[] {
       );
     }
   }
-  return parseIgnoreRulesToGlobs(rules, dirname);
+  try {
+    return parseIgnoreRulesToGlobs(rules, dirname);
+  } catch (err) {
+    console.error('Could not parse ignore rules to glob', { path });
+    throw new Error('Please make sure ignore file follows correct syntax');
+  }
 }
 
 export function getGlobPatterns(supportedFiles: SupportedFiles): string[] {

diff --git a/tests/files.spec.ts b/tests/files.spec.ts
@@ -29,6 +29,11 @@ describe('files', () => {
     const patterns = parseFileIgnores(`${sampleProjectPath}/exclude/.snyk`);
     expect(patterns).toEqual(bundleFileIgnores.slice(12));
   });
+  it('fails to parse dot snyk file with invalid field', () => {
+    expect(() => parseFileIgnores(`${sampleProjectPath}/invalid-dot-snyk/.snyk.invalid`)).toThrow(
+      'Please make sure ignore file follows correct syntax',
+    );
+  });
 
   it('collect ignore rules', async () => {
     const ignoreRules = await collectIgnoreRules([sampleProjectPath]);

diff --git a/tests/sample-repo/invalid-dot-snyk/.snyk.invalid b/tests/sample-repo/invalid-dot-snyk/.snyk.invalid
@@ -0,0 +1,6 @@
+exclude:
+  global:
+    - some/excluded/folder:
+        reason: None Given
+        expires: 2022-04-17T12:57:47.569Z
+        created: 2022-03-18T12:57:47.576Z