feat: 🥼 basic utilis and jest setup

Author: timkinnane

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 yarn.lock
+yarn-error.log
+coverage

esbuild-runner.config.mjs

@@ -0,0 +1,8 @@
+export default {
+  type: 'bundle',
+  esbuild: {
+    format: 'esm',
+    platform: 'node',
+    target: 'esnext'
+  }
+}

jest.config.mjs

@@ -0,0 +1,13 @@
+/** @type {import('@jest/types').Config.InitialOptions} */
+export default {
+  clearMocks: true,
+  collectCoverageFrom: ['src/**/*', '!**/index.ts'],
+  coverageDirectory: 'coverage',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleFileExtensions: [ 'ts', 'tsx', 'mjs', 'js', 'jsx', 'json', 'node' ],
+  transformIgnorePatterns: ['/node_modules/.*\\.js$'],
+  transform: {
+    '\\.(ts|tsx)?$': 'esbuild-runner/jest',
+  }
+}

package.json

@@ -2,9 +2,33 @@
   "name": "@nested-code/configs",
   "version": "0.0.1",
   "description": "Centralised config of dev tooling for Nested Code packages.",
-  "main": "index.js",
   "repository": "https://github.com/nested-code/configs",
   "author": "Tim Kinnane <[email protected]>",
   "license": "MIT",
-  "private": "false"
+  "private": "false",
+  "type": "module",
+  "scripts": {
+    "test": "jest --collectCoverage"
+  },
+  "dependencies": {
+    "@types/node": "14",
+    "esbuild": "^0.14.10",
+    "esbuild-runner": "^2.2.1",
+    "jest": "^27.4.5",
+    "jest-config": "^27.4.5",
+    "npm-dts": "^1.3.10",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.1.2"
+  },
+  "devDependencies": {
+    "@jest/types": "^27.4.2",
+    "@types/jest": "^27.4.0",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.4"
+  },
+  "exports": {
+    "import": "./esm/index.mjs",
+    "types": "./dist/index.d.ts",
+    "utils": "./dist/utils/index.mjs"
+  }
 }

src/jest/config.test.ts

@@ -0,0 +1,20 @@
+import { configure } from './config'
+
+describe('jest > configure', () => {
+  describe('configure', () => {
+    it('provides defaults', () => {
+      expect(configure())
+        .toMatchObject({
+          clearMocks: true,
+          collectCoverage: true,
+        })
+    })
+    it('merges args with defaults', () => {
+      expect(configure({ collectCoverage: false }))
+        .toMatchObject({
+          clearMocks: true,
+          collectCoverage: false,
+        })
+    })
+  })
+})

src/jest/config.ts

@@ -0,0 +1,23 @@
+import type { Config } from '@jest/types'
+
+export const defaults: Config.InitialOptions = {
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*', '!**/index.ts'],
+  coverageDirectory: 'coverage',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  transformIgnorePatterns: ['/node_modules/.*\\.js$'],
+  transform: {
+    '\\.(ts|tsx)?$': 'esbuild-runner/jest',
+  }
+}
+
+/**
+ * Merge cogs default initial options with any given.
+ * @todo Import from jest.config.mjs at root to keep in sync.
+ */
+export const configure = (options: Config.InitialOptions = {}): Config.InitialOptions => ({
+  ...defaults,
+  ...options
+})

src/jest/index.ts

@@ -0,0 +1,7 @@
+import * as config from './config'
+
+export const jest = {
+  ...config
+}
+
+export default jest

src/utils/index.ts

@@ -0,0 +1,7 @@
+import * as pkg from './package'
+
+export const utils = {
+  ...pkg
+}
+
+export default utils

src/utils/package.test.ts

@@ -0,0 +1,16 @@
+import { readPackage, requirePackage } from './package'
+
+describe('utils > package', () => {
+  describe('readPackage', () => {
+    it('reads current package json', () => {
+      expect(readPackage('./'))
+        .toHaveProperty('name', '@nested-code/configs')
+    })
+  })
+  describe('requirePackage', () => {
+    it('reads current package json', () => {
+      expect(requirePackage('./'))
+      .toHaveProperty('name', '@nested-code/configs')
+    })
+  })
+})

src/utils/package.ts

@@ -0,0 +1,9 @@
+import { readFileSync } from 'fs'
+import { createRequire } from 'module'
+import { resolve } from 'path'
+
+export const readPackage = (path: string) =>
+  JSON.parse(readFileSync(resolve(path, 'package.json'), { encoding: 'utf-8' }))
+
+export const requirePackage = (path: string) =>
+  createRequire(import.meta.url)(resolve(path, 'package.json'))