Merge pull request jest-community#332 from seanpoulter/feature/jest-community#313/Fix-regression-in-support-for-react-scripts

Fix regression detecting create-react-app

Author: orta

CHANGELOG.md

@@ -10,6 +10,8 @@ Bug-fixes within the same version aren't needed
   text editor - seanpoulter
 * Restart Jest with --watchAll when --watch is not supported without git/hg
   - seanpoulter
+* Fix regression in handling workspaces that have been bootstrapped with
+  create-react-app - seanpoulter
 
 -->
 

src/DebugConfigurationProvider.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode'
-import { getTestCommand, isCRATestCommand } from './helpers'
+import { getTestCommand, isCreateReactAppTestCommand } from './helpers'
 
 export class DebugConfigurationProvider implements vscode.DebugConfigurationProvider {
   private fileNameToRun: string = ''
@@ -63,7 +63,7 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
     }
 
     const testCommand = folder && getTestCommand(folder.uri.fsPath)
-    if (isCRATestCommand(testCommand)) {
+    if (isCreateReactAppTestCommand(testCommand)) {
       const craCommand = testCommand.split(' ')
       // Settings specific for projects bootstrapped with `create-react-app`
       debugConfiguration.runtimeExecutable = '${workspaceFolder}/node_modules/.bin/' + craCommand.shift()

src/JestExt.ts

@@ -4,7 +4,7 @@ import { Settings, ProjectWorkspace, JestTotalResults } from 'jest-editor-suppor
 import { matcher } from 'micromatch'
 
 import * as decorations from './decorations'
-import { IPluginSettings } from './IPluginSettings'
+import { IPluginSettings } from './Settings'
 import * as status from './statusBar'
 import {
   TestReconciliationState,

src/Settings/index.test.ts

@@ -0,0 +1,16 @@
+jest.unmock('../index')
+import { isDefaultPathToJest } from './index'
+
+describe('isDefaultPathToJest', () => {
+  it('returns true when the value is null', () => {
+    expect(isDefaultPathToJest(null)).toBe(true)
+  })
+
+  it('returns true for the legacy default ""', () => {
+    expect(isDefaultPathToJest('')).toBe(true)
+  })
+
+  it('returns false otherwise', () => {
+    expect(isDefaultPathToJest('')).toBe(false)
+  })
+})

src/IPluginSettings.ts src/Settings/index.tssrc/IPluginSettings.ts renamed to src/Settings/index.ts

@@ -1,4 +1,4 @@
-import { TestState } from './DebugCodeLens'
+import { TestState } from '../DebugCodeLens'
 
 export interface IPluginSettings {
   autoEnable?: boolean
@@ -17,3 +17,11 @@ export interface IPluginSettings {
   showCoverageOnLoad: boolean
   coverageFormatter: string
 }
+
+export function isDefaultPathToJest(str) {
+  return str === null || str === ''
+}
+
+export function hasUserSetPathToJest(str) {
+  return !isDefaultPathToJest(str)
+}

src/extension.ts

@@ -5,7 +5,7 @@ import * as path from 'path'
 import { extensionName } from './appGlobals'
 import { pathToJest, pathToConfig } from './helpers'
 import { JestExt } from './JestExt'
-import { IPluginSettings } from './IPluginSettings'
+import { IPluginSettings } from './Settings'
 import { registerStatusBar } from './statusBar'
 import { registerSnapshotCodeLens, registerSnapshotPreview } from './SnapshotCodeLens'
 import { registerCoverageCodeLens } from './Coverage'

src/helpers.ts

@@ -2,7 +2,7 @@ import { platform } from 'os'
 import { existsSync, readFileSync } from 'fs'
 import { normalize, join } from 'path'
 
-import { IPluginSettings } from './IPluginSettings'
+import { IPluginSettings, hasUserSetPathToJest } from './Settings'
 
 /**
  * Known binary names of `react-scripts` forks
@@ -11,7 +11,7 @@ const createReactAppBinaryNames = ['react-scripts', 'react-native-scripts', 'rea
 
 /**
  * Tries to read the test command from the scripts section within `package.json`
- * 
+ *
  * Returns the test command in case of success,
  * `undefined` if there was an exception while reading and parsing `package.json`
  * `null` if there is no test script
@@ -29,24 +29,24 @@ export function getTestCommand(rootPath: string): string | undefined | null {
   }
 }
 
-/** 
+/**
  * Checks if the supplied test command could have been generated by create-react-app
 */
-export function isCRATestCommand(testCommand: string): boolean {
+export function isCreateReactAppTestCommand(testCommand: string): boolean {
   return testCommand && createReactAppBinaryNames.some(binary => testCommand.indexOf(binary + ' test') === 0)
 }
 
 /**
  * Checks if the project in `rootPath` was bootstrapped by `create-react-app`.
  */
-function isBootstrappedWithCRA(rootPath: string): boolean {
+function isBootstrappedWithCreateReactApp(rootPath: string): boolean {
   const testCommand = getTestCommand(rootPath)
   if (testCommand === undefined) {
     // In case parsing `package.json` failed or was unconclusive,
     // fallback to checking for the presence of the binaries in `./node_modules/.bin`
     return createReactAppBinaryNames.some(binary => hasNodeExecutable(rootPath, binary))
   }
-  return isCRATestCommand(testCommand)
+  return isCreateReactAppTestCommand(testCommand)
 }
 
 function hasNodeExecutable(rootPath: string, executable: string): boolean {
@@ -56,29 +56,32 @@ function hasNodeExecutable(rootPath: string, executable: string): boolean {
 }
 
 /**
- *  Handles getting the jest runner, handling the OS and project specific work too
+ * Handles getting the jest runner, handling the OS and project specific work too
  *
  * @returns {string}
  */
-export function pathToJest(pluginSettings: IPluginSettings) {
-  if (pluginSettings.pathToJest) {
-    if (isBootstrappedWithCRA(pluginSettings.rootPath)) {
-      return 'npm test --'
-    }
-    return normalize(pluginSettings.pathToJest)
+export function pathToJest({ pathToJest, rootPath }: IPluginSettings) {
+  if (hasUserSetPathToJest(pathToJest)) {
+    return normalize(pathToJest)
   }
 
-  const platform = process.platform
-  if (platform === 'win32' && existsSync(join(pluginSettings.rootPath, 'node_modules', '.bin', 'jest.cmd'))) {
-    return normalize(join(pluginSettings.rootPath, 'node_modules', '.bin', 'jest.cmd'))
-  } else if (
-    (platform === 'linux' || platform === 'darwin') &&
-    existsSync(join(pluginSettings.rootPath, 'node_modules', '.bin', 'jest'))
-  ) {
-    return normalize(join(pluginSettings.rootPath, 'node_modules', '.bin', 'jest'))
+  if (isBootstrappedWithCreateReactApp(rootPath)) {
+    return 'npm test --'
   }
 
-  return 'jest'
+  const localJestExecutable = pathToLocalJestExecutable(rootPath)
+  if (existsSync(localJestExecutable)) {
+    return localJestExecutable
+  }
+  return `jest${isWindows() ? '.cmd' : ''}`
+}
+
+function pathToLocalJestExecutable(rootDir) {
+  return normalize(join(rootDir, `node_modules/.bin/jest${isWindows() ? '.cmd' : ''}`))
+}
+
+function isWindows() {
+  return platform() === 'win32'
 }
 
 /**

tests/DebugConfigurationProvider.test.ts

@@ -1,7 +1,7 @@
 jest.unmock('../src/DebugConfigurationProvider')
 
 import { DebugConfigurationProvider } from '../src/DebugConfigurationProvider'
-import { getTestCommand, isCRATestCommand } from '../src/helpers'
+import { getTestCommand, isCreateReactAppTestCommand } from '../src/helpers'
 
 describe('DebugConfigurationProvider', () => {
   it('should by default return a DebugConfiguration for Jest', () => {
@@ -18,7 +18,7 @@ describe('DebugConfigurationProvider', () => {
   })
   it('should return a valid CRA DebugConfiguration', () => {
     ;(getTestCommand as jest.Mock<Function>).mockReturnValueOnce('react-scripts test --env=jsdom')
-    ;(isCRATestCommand as jest.Mock<Function>).mockReturnValueOnce(true)
+    ;(isCreateReactAppTestCommand as jest.Mock<Function>).mockReturnValueOnce(true)
 
     const folder: any = { uri: { fsPath: null } }
     const sut = new DebugConfigurationProvider()