Added excludeExact option for concise file exclusion (#87)

Author: sgb-io

README.md

@@ -119,6 +119,7 @@ To customise your analysis, use the following options, placed in a `codehawk.jso
 | `extensions`         | File extensions that should be analyzed. The default is always used, but you can add more extensions. You can use the `exclude[...]` options to exclude specific files.                                                                                                      | `['.js', '.jsx', '.ts', '.tsx']`                |
 | `excludeFilenames`   | Filename matches that should be excluded from static analysis (but still show in the data). The default is always used, but you can add more matches to be excluded. Note that the matching is exact. The exclude list is taken into consideration after the extension list. | `['.d.ts', '.min.js', '.bundle.js']`            |
 | `excludeDirectories` | Directory matches that should be excluded from static analysis (but still show in the data). Relative to the root. E.g. `['/fixtures', '/test']`                                                                                                                             | `['/dist', '/bin', '/build']`                   |
+| `excludeExact`       | Exact file matches that should be excluded from static analysis (but still show in the data). Relative to the root. E.g. `['/src/foo/bar.ts']`                                                                                                                               | `[]`                                            |
 | `skipDirectories`    | Directories that should be excluded completely, i.e. not visible in the resulting data at all. The defaults will always be skipped.                                                                                                                                          | `['/node_modules', '/flow-typed', '/coverage']` |
 
 ## Badges

generated/avg-maintainability.svg

@@ -25,6 +25,11 @@ const baseOptions: CodehawkOptions = {
     default: ['/dist', '/bin', '/build'],
     replaceDefault: true,
   },
+  excludeExact: {
+    type: 'stringArray',
+    default: [],
+    replaceDefault: true,
+  },
   excludeFilenames: {
     type: 'stringArray',
     default: ['.d.ts', '.min.js', '.bundle.js'],
@@ -60,9 +65,10 @@ const injectOptionValues = ({
       break
     case 'badgesDirectory':
     case 'excludeDirectories':
+    case 'excludeExact':
     case 'excludeFilenames':
-    case 'skipDirectories':
     case 'extensions':
+    case 'skipDirectories':
       newOptions[optionKey] = val as string[]
       break
     case 'minimumThreshold':

src/options.ts

@@ -1,10 +1,11 @@
 // All option keys
 type SupportedStringArrayKeys =
-    | 'extensions'
+    | 'badgesDirectory'
     | 'excludeDirectories'
+    | 'excludeExact'
     | 'excludeFilenames'
+    | 'extensions'
     | 'skipDirectories'
-    | 'badgesDirectory'
 type SupportedBooleanOptions = 'enableFlow'
 type SupportedNumberOptions = 'minimumThreshold'
 

src/types/codehawk.ts

@@ -1,7 +1,9 @@
 import { isBlocklisted } from './util'
 import { buildOptions } from './options'
 
-const options = buildOptions({})
+const options = buildOptions({
+  excludeExact: ['/src/foo/excluded.ts'],
+})
 
 describe('util', () => {
   describe('isBlocklisted', () => {
@@ -55,5 +57,12 @@ describe('util', () => {
         expect(isBlocklisted('/build/foo', 'index.ts', options)).toEqual(true)
       })
     })
+
+    describe('excludeExact', () => {
+      it('excludes an exact match', () => {
+        expect(isBlocklisted('/src/foo', 'bar.ts', options)).toEqual(false)
+        expect(isBlocklisted('/src/foo', 'excluded.ts', options)).toEqual(true)
+      })
+    })
   })
 })

src/util.test.ts

@@ -23,7 +23,7 @@ export const isBlocklisted = (
   filename: string,
   options: AssembledOptions
 ): boolean => {
-  const { excludeDirectories, excludeFilenames } = options
+  const { excludeDirectories, excludeFilenames, excludeExact } = options
 
   // Check for blocklisted directories
   for (let i = 0; i < excludeDirectories.length; i += 1) {
@@ -39,6 +39,13 @@ export const isBlocklisted = (
     }
   }
 
+  // Check for exact matches
+  for (let i = 0; i < excludeExact.length; i += 1) {
+    if (excludeExact[i] === `${relativeDir}/${filename}`) {
+      return true
+    }
+  }
+
   return false
 }