feat: use generated index to exclude from coverage

Breaking Change

Not really, but it feels like a good thing to draw a line under

.github/workflows/validate.yml

@@ -84,6 +84,9 @@ jobs:
           path: lib
           key: lib-${{github.sha}}
 
+      - name: 🧙‍♂️ Build Index
+        run: npm run build:index
+
       - name: 🏗 TypeScript
         run: npm run build
 

.gitignore

@@ -1,3 +1,4 @@
 coverage/
 node_modules/
-lib/
+lib/
+src/index.ts

package.json

@@ -7,6 +7,7 @@
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules kcd-scripts test --runInBand --detectOpenHandles",
     "lint": "kcd-scripts lint",
     "build": "tsc",
+    "build:index": "node ./scripts/build.cjs",
     "document": "typedoc --out ./docs --entryPoints src/index.ts --name Utils --readme Readme.md && echo utils.arcath.net > ./docs/CNAME",
     "validate": "kcd-scripts validate",
     "format": "kcd-scripts format"

scripts/build.cjs

@@ -0,0 +1,31 @@
+const path = require('path')
+const fs = require('fs')
+
+const FUNCTIONS = path.join(__dirname, '..', 'src', 'functions')
+const CLASSES = path.join(__dirname, '..', 'src', 'classes')
+
+const INDEX = path.join(__dirname, '..', 'src', 'index.ts')
+
+const lines = [`// Automatically generated by ./scripts/build.cjs`, '']
+
+fs.readdir(FUNCTIONS, (err, files) => {
+  files.forEach(file => {
+    if (file.match(`\.spec\.`)) {
+      return
+    }
+
+    lines.push(`export * from './functions/${file.replace('.ts', '')}'`)
+  })
+
+  fs.readdir(CLASSES, (err, files) => {
+    files.forEach(file => {
+      if (file.match(`\.spec\.`)) {
+        return
+      }
+
+      lines.push(`export * from './classes/${file.replace('.ts', '')}'`)
+    })
+
+    fs.writeFile(INDEX, lines.join(`\r\n`), err => {})
+  })
+})

src/classes/bit-mask.spec.ts

@@ -1,4 +1,4 @@
-import {BitMask} from '../'
+import {BitMask} from './bit-mask'
 
 const READ = 'read'
 const WRITE = 'write'

src/classes/logger.spec.ts

@@ -2,7 +2,7 @@
 // eslint-disable-next-line
 import {jest} from '@jest/globals'
 
-import {Logger} from '../'
+import {Logger} from './logger'
 
 describe('Logger', () => {
   it('should log messages', () => {

src/functions/address-object.spec.ts

@@ -1,4 +1,4 @@
-import {addressObject, testObjectAddress} from '../'
+import {addressObject, testObjectAddress} from './address-object'
 
 describe('Address Object', () => {
   it('should address an object', () => {

src/functions/array-move.spec.ts

@@ -1,4 +1,4 @@
-import {arrayMove} from '../index'
+import {arrayMove} from './array-move'
 
 describe('Array Move', () => {
   it('should move objects in an array', () => {

src/functions/array-selectors.spec.ts

@@ -1,4 +1,4 @@
-import {randomEntry} from '../'
+import {randomEntry} from './array-selectors'
 
 describe('Array Selectors', () => {
   it('should select a random entry', () => {

src/functions/async-for-each.spec.ts

@@ -1,4 +1,4 @@
-import {asyncForEach} from '../'
+import {asyncForEach} from './async-for-each'
 
 describe('Async For Each (in sequence)', () => {
   it('should work async', async () => {

src/functions/async-map.spec.ts

@@ -1,4 +1,4 @@
-import {asyncMap} from '../'
+import {asyncMap} from './async-map'
 
 describe('Async Map', () => {
   it('should work async', async () => {

src/functions/cache-for.spec.ts

@@ -8,7 +8,7 @@ import {
   cacheKey,
   resetCache,
   cacheKeyExists
-} from '../'
+} from './cache-for'
 
 jest.setTimeout(20000)
 

src/functions/clamp.spec.ts

@@ -1,4 +1,4 @@
-import {clamp} from '../'
+import {clamp} from './clamp'
 
 describe('clamp', () => {
   it('should clamp values', () => {

src/functions/create-map.spec.ts

@@ -1,4 +1,4 @@
-import {createMap} from '../'
+import {createMap} from './create-map'
 
 describe('Create Map', () => {
   it('should create a map', () => {

src/functions/css.spec.ts

@@ -9,7 +9,7 @@ import {
   numberToRem,
   numberToVh,
   numberToVw
-} from '../'
+} from './css'
 
 describe('CSS', () => {
   it('should conver units to numbers', () => {

src/functions/dates.spec.ts

@@ -1,11 +1,11 @@
-import {lastModifiedHeaderDate} from '../index'
+import {lastModifiedHeaderDate} from './dates'
 
 describe('Dates', () => {
-  it('should generate a last modified date',  () => {
-    const timeString = "Wed Apr 6 2022 09:38:39 GMT+0100 (British Summer Time)"
+  it('should generate a last modified date', () => {
+    const timeString = 'Wed Apr 6 2022 09:38:39 GMT+0100 (British Summer Time)'
 
     const lastModified = lastModifiedHeaderDate(timeString)
 
     expect(lastModified).toBe('Wed, 06 Apr 2022 08:38:39 GMT')
   })
-})
+})

src/functions/deep-includes.spec.ts

@@ -1,4 +1,4 @@
-import {deepIncludesArray} from '../index'
+import {deepIncludesArray} from './deep-includes'
 
 describe('Deep Includes', () => {
   test('it should return the correct value', () => {

src/functions/defaults.spec.ts

@@ -1,4 +1,4 @@
-import {defaults} from '../'
+import {defaults} from './defaults'
 
 describe('Defaults', () => {
   it('should set defaults', () => {

src/functions/diff-array.spec.ts

@@ -1,4 +1,4 @@
-import {diffArray} from '../'
+import {diffArray} from './diff-array'
 
 describe('diffArray', () => {
   it('should diff arrays', () => {

src/functions/diff-object.spec.ts

@@ -1,4 +1,4 @@
-import {diffObject} from '../'
+import {diffObject} from './diff-object'
 
 describe('Diff Object', () => {
   it('should diff two objects', () => {

src/functions/grouped-by.spec.ts

@@ -1,4 +1,4 @@
-import {groupedBy} from '../'
+import {groupedBy} from './grouped-by'
 
 describe('Grouped By', () => {
   it('should group items', () => {

src/functions/if-fn.spec.ts

@@ -1,4 +1,4 @@
-import {ifFn} from '../index'
+import {ifFn} from './if-fn'
 import {hasDevDependency} from './package'
 
 describe('If FN', () => {

src/functions/increment.spec.ts

@@ -1,4 +1,4 @@
-import {increment, decrement} from '../index'
+import {increment, decrement} from './increment'
 
 describe('Increment', () => {
   it('should increment', () => {

src/functions/indexed-by.spec.ts

@@ -1,4 +1,4 @@
-import {indexedBy} from '../'
+import {indexedBy} from './indexed-by'
 
 describe('Indexed By', () => {
   it('should produce an index', () => {

src/functions/invariant.spec.ts

@@ -1,6 +1,6 @@
 import {expectTypeOf} from 'expect-type'
 
-import {invariant} from '../'
+import {invariant} from './invariant'
 
 describe('invariant', () => {
   it('should throw errors', () => {

src/functions/is-env.spec.ts

@@ -1,4 +1,4 @@
-import {isEnv} from '../'
+import {isEnv} from './is-env'
 
 describe('isEnv', () => {
   it('should get the env', () => {

src/functions/keys.spec.ts

@@ -1,4 +1,4 @@
-import {keys, keyValue} from '../'
+import {keys, keyValue} from './keys'
 
 describe('Keys', () => {
   it('should return an array of keys', () => {

src/functions/map-property.spec.ts

@@ -1,4 +1,4 @@
-import {mapProperty} from '../'
+import {mapProperty} from './map-property'
 
 describe('Map Property', () => {
   it('should map properties', () => {

src/functions/network.spec.ts

@@ -1,4 +1,4 @@
-import {parseCDIR} from '../index'
+import {parseCDIR} from './network'
 
 describe('Network', () => {
   it('should parse', () => {

src/functions/nl2br.spec.ts

@@ -1,4 +1,4 @@
-import {nl2br} from '../'
+import {nl2br} from './nl2br'
 
 describe('NL2BR', () => {
   it('should add line breaks', () => {

src/functions/parameterize.spec.ts

@@ -1,4 +1,4 @@
-import {parameterize} from '../'
+import {parameterize} from './parameterize'
 
 describe('Parameterize', () => {
   it('should make strings safe for urls', () => {

src/functions/pick.spec.ts

@@ -1,4 +1,4 @@
-import {pick, omit} from '../'
+import {pick, omit} from './pick'
 
 describe('Pick & Omit', () => {
   it('should pick elements', () => {

src/functions/range-as-string.spec.ts

@@ -1,4 +1,4 @@
-import {rangeAsString, rangeAsArray} from '../'
+import {rangeAsString, rangeAsArray} from './range-as-string'
 
 describe('Range As String', () => {
   it('should create strings', () => {

src/functions/reduce.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line
 import {jest} from '@jest/globals'
 
-import {reduceTruthy, reduceFalsy, reducio} from '../index'
+import {reduceTruthy, reduceFalsy, reducio} from './reduce'
 
 describe('Reduce Functions', () => {
   it('should reduce truthy', () => {

src/functions/replace-property.spec.ts

@@ -1,4 +1,4 @@
-import {replaceProperty} from '../index'
+import {replaceProperty} from './replace-property'
 
 describe('Replace Property', () => {
   it('should replace a property', () => {

src/functions/selectors.spec.ts

@@ -1,4 +1,4 @@
-import {propIs, propIsNot} from '../'
+import {propIs, propIsNot} from './selectors'
 
 describe('Selectors', () => {
   it('should select items', () => {

src/functions/time.spec.ts

@@ -17,7 +17,7 @@ import {
   HOUR_IN_MINUTES,
   HOUR_IN_SECONDS,
   HOUR_IN_MS
-} from '../'
+} from './time'
 
 describe('Time FNS', () => {
   it('should calculate values', () => {

src/functions/times.spec.ts

@@ -1,4 +1,4 @@
-import {times, asyncTimes} from '../'
+import {times, asyncTimes} from './times'
 
 describe('Times', () => {
   it('should interate', () => {

src/functions/unique.spec.ts

@@ -1,4 +1,4 @@
-import {unique} from '../'
+import {unique} from './unique'
 
 describe('Unique', () => {
   it('should find unique values', () => {

src/functions/value-or.spec.ts

@@ -1,4 +1,4 @@
-import {valueOr} from '../'
+import {valueOr} from './value-or'
 
 describe('ValueOr', () => {
   it('should work', () => {

src/functions/wait-for.spec.ts

@@ -1,4 +1,4 @@
-import {waitFor} from '../'
+import {waitFor} from './wait-for'
 
 describe('waitFor', () => {
   it('should return T', async () => {