-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'js-um/fix-to-work-with-jest-projects-root-path' into co…
…mbine-prs
- Loading branch information
Showing
11 changed files
with
286 additions
and
185 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,185 +1,188 @@ | ||
| import * as crypto from 'crypto'; | ||
| import * as fs from 'fs'; | ||
| import * as fsExtra from 'fs-extra'; | ||
| import * as path from 'path'; | ||
| import * as tsc from 'typescript'; | ||
| import { ConfigGlobals, JestConfig, TsJestConfig } from './jest-types'; | ||
| import { logOnce } from './logger'; | ||
| import * as _ from 'lodash'; | ||
|
|
||
| export function getTSJestConfig(globals: ConfigGlobals): TsJestConfig { | ||
| return globals && globals['ts-jest'] ? globals['ts-jest'] : {}; | ||
| } | ||
|
|
||
| function formatTsDiagnostics(errors: tsc.Diagnostic[]): string { | ||
| const defaultFormatHost: tsc.FormatDiagnosticsHost = { | ||
| getCurrentDirectory: () => tsc.sys.getCurrentDirectory(), | ||
| getCanonicalFileName: fileName => fileName, | ||
| getNewLine: () => tsc.sys.newLine, | ||
| }; | ||
|
|
||
| return tsc.formatDiagnostics(errors, defaultFormatHost); | ||
| } | ||
|
|
||
| function readCompilerOptions( | ||
| configPath: string, | ||
| rootDir: string, | ||
| ): tsc.CompilerOptions { | ||
| configPath = path.resolve(rootDir, configPath); | ||
| const { config, error } = tsc.readConfigFile(configPath, tsc.sys.readFile); | ||
| if (error) { | ||
| throw error; | ||
| } | ||
|
|
||
| const { errors, options } = tsc.parseJsonConfigFileContent( | ||
| config, | ||
| tsc.sys, | ||
| path.resolve(rootDir), | ||
| ); | ||
|
|
||
| if (errors.length > 0) { | ||
| const formattedErrors = formatTsDiagnostics(errors); | ||
| throw new Error( | ||
| `Some errors occurred while attempting to read from ${configPath}: ${formattedErrors}`, | ||
| ); | ||
| } | ||
|
|
||
| return options; | ||
| } | ||
|
|
||
| function getStartDir(): string { | ||
| // This is needed because of the way our tests are structured. | ||
| // If this is being executed as a library (under node_modules) | ||
| // we want to start with the project directory that's three | ||
| // levels above. | ||
| // If this is being executed from the test suite, we want to start | ||
| // in the directory of the test | ||
|
|
||
| const grandparent = path.resolve(__dirname, '..', '..'); | ||
| if (grandparent.endsWith(`${path.sep}node_modules`)) { | ||
| return process.cwd(); | ||
| } | ||
|
|
||
| return '.'; | ||
| } | ||
|
|
||
| function getPathToClosestTSConfig( | ||
| startDir?: string, | ||
| previousDir?: string, | ||
| ): string { | ||
| // Starting with the startDir directory and moving on to the | ||
| // parent directory recursively (going no further than the root directory) | ||
| // find and return the path to the first encountered tsconfig.json file | ||
|
|
||
| if (!startDir) { | ||
| return getPathToClosestTSConfig(getStartDir()); | ||
| } | ||
|
|
||
| const tsConfigPath = path.join(startDir, 'tsconfig.json'); | ||
|
|
||
| const startDirPath = path.resolve(startDir); | ||
| const previousDirPath = path.resolve(previousDir || '/'); | ||
|
|
||
| if (startDirPath === previousDirPath || fs.existsSync(tsConfigPath)) { | ||
| return tsConfigPath; | ||
| } | ||
|
|
||
| return getPathToClosestTSConfig(path.join(startDir, '..'), startDir); | ||
| } | ||
|
|
||
| function getTSConfigPathFromConfig(globals: ConfigGlobals): string { | ||
| const defaultTSConfigFile = getPathToClosestTSConfig(); | ||
| if (!globals) { | ||
| return defaultTSConfigFile; | ||
| } | ||
|
|
||
| const tsJestConfig = getTSJestConfig(globals); | ||
|
|
||
| if (tsJestConfig.tsConfigFile) { | ||
| return tsJestConfig.tsConfigFile; | ||
| } | ||
|
|
||
| return defaultTSConfigFile; | ||
| } | ||
|
|
||
| export function mockGlobalTSConfigSchema( | ||
| globals: ConfigGlobals, | ||
| ): ConfigGlobals { | ||
| const configPath = getTSConfigPathFromConfig(globals); | ||
| return { 'ts-jest': { tsConfigFile: configPath } }; | ||
| } | ||
|
|
||
| export const getTSConfig = _.memoize(getTSConfig_local, (globals, rootDir) => { | ||
| // check cache before resolving configuration | ||
| // NB: We use JSON.stringify() to create a consistent, unique signature. Although it lacks a uniform | ||
| // shape, this is simpler and faster than using the crypto package to generate a hash signature. | ||
| return JSON.stringify(globals, rootDir); | ||
| }); | ||
|
|
||
| // Non-memoized version of TSConfig | ||
| function getTSConfig_local(globals, rootDir: string = '') { | ||
| const configPath = getTSConfigPathFromConfig(globals); | ||
| logOnce(`Reading tsconfig file from path ${configPath}`); | ||
| const skipBabel = getTSJestConfig(globals).skipBabel; | ||
|
|
||
| const config = readCompilerOptions(configPath, rootDir); | ||
| logOnce('Original typescript config before modifications: ', { ...config }); | ||
|
|
||
| // ts-jest will map lines numbers properly if inlineSourceMap and | ||
| // inlineSources are set to true. The sourceMap configuration | ||
| // is used to send the sourcemap back to Jest | ||
| delete config.sourceMap; | ||
| config.inlineSourceMap = true; | ||
| config.inlineSources = true; | ||
|
|
||
| // the coverage report is broken if `.outDir` is set | ||
| // see https://github.com/kulshekhar/ts-jest/issues/201 | ||
| // `.outDir` is removed even for test files as it affects with breakpoints | ||
| // see https://github.com/kulshekhar/ts-jest/issues/309 | ||
| delete config.outDir; | ||
|
|
||
| if (configPath === path.join(getStartDir(), 'tsconfig.json')) { | ||
| // hardcode module to 'commonjs' in case the config is being loaded | ||
| // from the default tsconfig file. This is to ensure that coverage | ||
| // works well. If there's a need to override, it can be done using | ||
| // a custom tsconfig for testing | ||
| config.module = tsc.ModuleKind.CommonJS; | ||
| } | ||
|
|
||
| config.module = config.module || tsc.ModuleKind.CommonJS; | ||
| config.jsx = config.jsx || tsc.JsxEmit.React; | ||
|
|
||
| return config; | ||
| } | ||
|
|
||
| export function cacheFile( | ||
| jestConfig: JestConfig, | ||
| filePath: string, | ||
| src: string, | ||
| ): void { | ||
| // store transpiled code contains source map into cache, except test cases | ||
| if (!jestConfig.testRegex || !filePath.match(jestConfig.testRegex)) { | ||
| const outputFilePath = path.join( | ||
| jestConfig.cacheDirectory, | ||
| '/ts-jest/', | ||
| crypto | ||
| .createHash('md5') | ||
| .update(filePath) | ||
| .digest('hex'), | ||
| ); | ||
|
|
||
| fsExtra.outputFileSync(outputFilePath, src); | ||
| } | ||
| } | ||
|
|
||
| export function runTsDiagnostics( | ||
| filePath: string, | ||
| compilerOptions: tsc.CompilerOptions, | ||
| ): void { | ||
| const program = tsc.createProgram([filePath], compilerOptions); | ||
| const allDiagnostics = tsc.getPreEmitDiagnostics(program); | ||
|
|
||
| if (allDiagnostics.length) { | ||
| throw new Error(formatTsDiagnostics(allDiagnostics)); | ||
| } | ||
| } | ||
| import * as crypto from 'crypto'; | ||
| import * as fs from 'fs'; | ||
| import * as fsExtra from 'fs-extra'; | ||
| import * as path from 'path'; | ||
| import * as tsc from 'typescript'; | ||
| import { ConfigGlobals, JestConfig, TsJestConfig } from './jest-types'; | ||
| import { logOnce } from './logger'; | ||
| import * as _ from 'lodash'; | ||
|
|
||
| export function getTSJestConfig(globals: ConfigGlobals): TsJestConfig { | ||
| return globals && globals['ts-jest'] ? globals['ts-jest'] : {}; | ||
| } | ||
|
|
||
| function formatTsDiagnostics(errors: tsc.Diagnostic[]): string { | ||
| const defaultFormatHost: tsc.FormatDiagnosticsHost = { | ||
| getCurrentDirectory: () => tsc.sys.getCurrentDirectory(), | ||
| getCanonicalFileName: fileName => fileName, | ||
| getNewLine: () => tsc.sys.newLine, | ||
| }; | ||
|
|
||
| return tsc.formatDiagnostics(errors, defaultFormatHost); | ||
| } | ||
|
|
||
| function readCompilerOptions( | ||
| configPath: string, | ||
| rootDir: string, | ||
| ): tsc.CompilerOptions { | ||
| configPath = path.resolve(rootDir, configPath); | ||
| const { config, error } = tsc.readConfigFile(configPath, tsc.sys.readFile); | ||
| if (error) { | ||
| throw error; | ||
| } | ||
|
|
||
| const { errors, options } = tsc.parseJsonConfigFileContent( | ||
| config, | ||
| tsc.sys, | ||
| path.resolve(rootDir), | ||
| ); | ||
|
|
||
| if (errors.length > 0) { | ||
| const formattedErrors = formatTsDiagnostics(errors); | ||
| throw new Error( | ||
| `Some errors occurred while attempting to read from ${configPath}: ${formattedErrors}`, | ||
| ); | ||
| } | ||
|
|
||
| return options; | ||
| } | ||
|
|
||
| function getStartDir(): string { | ||
| // This is needed because of the way our tests are structured. | ||
| // If this is being executed as a library (under node_modules) | ||
| // we want to start with the project directory that's three | ||
| // levels above. | ||
| // If this is being executed from the test suite, we want to start | ||
| // in the directory of the test | ||
|
|
||
| const grandparent = path.resolve(__dirname, '..', '..'); | ||
| if (grandparent.endsWith(`${path.sep}node_modules`)) { | ||
| return process.cwd(); | ||
| } | ||
|
|
||
| return '.'; | ||
| } | ||
|
|
||
| function getPathToClosestTSConfig( | ||
| startDir?: string, | ||
| previousDir?: string, | ||
| ): string { | ||
| // Starting with the startDir directory and moving on to the | ||
| // parent directory recursively (going no further than the root directory) | ||
| // find and return the path to the first encountered tsconfig.json file | ||
|
|
||
| if (!startDir) { | ||
| return getPathToClosestTSConfig(getStartDir()); | ||
| } | ||
|
|
||
| const tsConfigPath = path.join(startDir, 'tsconfig.json'); | ||
|
|
||
| const startDirPath = path.resolve(startDir); | ||
| const previousDirPath = path.resolve(previousDir || '/'); | ||
|
|
||
| if (startDirPath === previousDirPath || fs.existsSync(tsConfigPath)) { | ||
| return tsConfigPath; | ||
| } | ||
|
|
||
| return getPathToClosestTSConfig(path.join(startDir, '..'), startDir); | ||
| } | ||
|
|
||
| function getTSConfigPathFromConfig( | ||
| globals: ConfigGlobals, | ||
| rootDir?: string, | ||
| ): string { | ||
| const defaultTSConfigFile = getPathToClosestTSConfig(rootDir); | ||
| if (!globals) { | ||
| return defaultTSConfigFile; | ||
| } | ||
|
|
||
| const tsJestConfig = getTSJestConfig(globals); | ||
|
|
||
| if (tsJestConfig.tsConfigFile) { | ||
| return tsJestConfig.tsConfigFile; | ||
| } | ||
|
|
||
| return defaultTSConfigFile; | ||
| } | ||
|
|
||
| export function mockGlobalTSConfigSchema( | ||
| globals: ConfigGlobals, | ||
| ): ConfigGlobals { | ||
| const configPath = getTSConfigPathFromConfig(globals); | ||
| return { 'ts-jest': { tsConfigFile: configPath } }; | ||
| } | ||
|
|
||
| export const getTSConfig = _.memoize(getTSConfig_local, (globals, rootDir) => { | ||
| // check cache before resolving configuration | ||
| // NB: We use JSON.stringify() to create a consistent, unique signature. Although it lacks a uniform | ||
| // shape, this is simpler and faster than using the crypto package to generate a hash signature. | ||
| return JSON.stringify(globals, rootDir); | ||
| }); | ||
|
|
||
| // Non-memoized version of TSConfig | ||
| function getTSConfig_local(globals, rootDir: string = '') { | ||
| const configPath = getTSConfigPathFromConfig(globals, rootDir); | ||
| logOnce(`Reading tsconfig file from path ${configPath}`); | ||
| const skipBabel = getTSJestConfig(globals).skipBabel; | ||
|
|
||
| const config = readCompilerOptions(configPath, rootDir); | ||
| logOnce('Original typescript config before modifications: ', { ...config }); | ||
|
|
||
| // ts-jest will map lines numbers properly if inlineSourceMap and | ||
| // inlineSources are set to true. The sourceMap configuration | ||
| // is used to send the sourcemap back to Jest | ||
| delete config.sourceMap; | ||
| config.inlineSourceMap = true; | ||
| config.inlineSources = true; | ||
|
|
||
| // the coverage report is broken if `.outDir` is set | ||
| // see https://github.com/kulshekhar/ts-jest/issues/201 | ||
| // `.outDir` is removed even for test files as it affects with breakpoints | ||
| // see https://github.com/kulshekhar/ts-jest/issues/309 | ||
| delete config.outDir; | ||
|
|
||
| if (configPath === path.join(getStartDir(), 'tsconfig.json')) { | ||
| // hardcode module to 'commonjs' in case the config is being loaded | ||
| // from the default tsconfig file. This is to ensure that coverage | ||
| // works well. If there's a need to override, it can be done using | ||
| // a custom tsconfig for testing | ||
| config.module = tsc.ModuleKind.CommonJS; | ||
| } | ||
|
|
||
| config.module = config.module || tsc.ModuleKind.CommonJS; | ||
| config.jsx = config.jsx || tsc.JsxEmit.React; | ||
|
|
||
| return config; | ||
| } | ||
|
|
||
| export function cacheFile( | ||
| jestConfig: JestConfig, | ||
| filePath: string, | ||
| src: string, | ||
| ): void { | ||
| // store transpiled code contains source map into cache, except test cases | ||
| if (!jestConfig.testRegex || !filePath.match(jestConfig.testRegex)) { | ||
| const outputFilePath = path.join( | ||
| jestConfig.cacheDirectory, | ||
| '/ts-jest/', | ||
| crypto | ||
| .createHash('md5') | ||
| .update(filePath) | ||
| .digest('hex'), | ||
| ); | ||
|
|
||
| fsExtra.outputFileSync(outputFilePath, src); | ||
| } | ||
| } | ||
|
|
||
| export function runTsDiagnostics( | ||
| filePath: string, | ||
| compilerOptions: tsc.CompilerOptions, | ||
| ): void { | ||
| const program = tsc.createProgram([filePath], compilerOptions); | ||
| const allDiagnostics = tsc.getPreEmitDiagnostics(program); | ||
|
|
||
| if (allDiagnostics.length) { | ||
| throw new Error(formatTsDiagnostics(allDiagnostics)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import runJest from '../__helpers__/runJest'; | ||
|
|
||
| describe('Jest Projects with workspace', () => { | ||
| it('should find ./tsconfig.json in sub projects properly with jest projects and yarn workspace options', () => { | ||
| const result = runJest('../jest-projects-with-workspace', ['--no-cache']); | ||
| const stderr = result.stderr; | ||
| expect(result.status).toEqual(0); | ||
| expect(stderr).toContain('2 passed, 2 total'); | ||
| }); | ||
| }); |
Oops, something went wrong.