address changes and add peerdep to jest-cli

Financial-Times · Jan 14, 2022 · de3f676 · de3f676
1 parent aa7967d
commit de3f676
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/core/sandbox/package.json b/core/sandbox/package.json
@@ -20,11 +20,13 @@
     "@dotcom-tool-kit/lint-staged": "file:../../plugins/lint-staged",
     "@dotcom-tool-kit/lint-staged-npm": "file:../../plugins/lint-staged-npm",
     "@dotcom-tool-kit/mocha": "file:../../plugins/mocha",
+    "@dotcom-tool-kit/jest": "file:../../plugins/jest",
     "@dotcom-tool-kit/n-test": "file:../../plugins/n-test",
     "@dotcom-tool-kit/npm": "file:../../plugins/npm",
     "@dotcom-tool-kit/prettier": "file:../../plugins/prettier",
     "@dotcom-tool-kit/upload-assets-to-s3": "file:../../plugins/upload-assets-to-s3",
-    "dotcom-tool-kit": "file:../cli"
+    "dotcom-tool-kit": "file:../cli",
+    "jest-cli": "^27.4.7"
   },
   "volta": {
     "extends": "../../package.json"
@@ -34,7 +36,6 @@
     "@dotcom-tool-kit/node": "file:../../plugins/node"
   },
   "husky": {
-    "pre-commit": "dotcom-tool-kit git:precommit",
     "hooks": {
       "pre-commit": "dotcom-tool-kit git:precommit"
     }

diff --git a/lib/types/src/schema/jest.ts b/lib/types/src/schema/jest.ts
@@ -3,6 +3,7 @@ import { SchemaOutput } from '../schema'
 export const JestSchema = {
   configPath: 'string?'
 } as const
+export type JestMode = "ci" | "local"
 export type JestOptions = SchemaOutput<typeof JestSchema>
 
 export const Schema = JestSchema
diff --git a/plugins/jest/package.json b/plugins/jest/package.json
@@ -10,8 +10,10 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/types": "file:../../lib/types",
-    "jest-cli": "^27.4.7"
+    "@dotcom-tool-kit/types": "file:../../lib/types"
+  },
+  "peerDependencies": {
+    "jest-cli": "27.x"
   },
   "repository": {
     "type": "git",

diff --git a/plugins/jest/src/run-jest.ts b/plugins/jest/src/run-jest.ts
@@ -1,9 +1,9 @@
 import { fork } from 'child_process'
-import type { JestOptions } from '@dotcom-tool-kit/types/lib/schema/jest'
-
+import type { JestOptions, JestMode } from '@dotcom-tool-kit/types/lib/schema/jest'
+import { ToolKitError } from '@dotcom-tool-kit/error'
 const jestCLIPath = require.resolve('jest-cli/bin/jest')
 
-export default function runJest(mode: string, options: JestOptions) : Promise<void> {
+export default function runJest(mode: JestMode, options: JestOptions) : Promise<void> {
     return new Promise((resolve, reject) => {
         const config = [
           mode === 'ci' ? '--ci' : '', 
@@ -15,7 +15,7 @@ export default function runJest(mode: string, options: JestOptions) : Promise<vo
           if (code === 0) {
             resolve()
           } else {
-            reject(new Error(`Jest returned an error`))
+            reject(new ToolKitError(`Jest returned an error`))
           }
         })
       })

diff --git a/plugins/jest/tests/jest-plugin.test.ts b/plugins/jest/tests/jest-plugin.test.ts
@@ -5,7 +5,7 @@ import EventEmitter from 'events'
 
 jest.mock('child_process', () => ({
     fork: jest.fn(() => {
-      // return a fake emitter that immediately sends an "exit" event, so the webpack task resolves
+      // return a fake emitter that immediately sends an "exit" event, so the jest task resolves
       const emitter = new EventEmitter()
       process.nextTick(() => {
         emitter.emit('exit', 0)