chore: remove Path and Glob (#12406)

Author: SimenB

CHANGELOG.md

@@ -48,6 +48,7 @@
 - `[jest-serializer]` [**BREAKING**] Deprecate package in favour of using `v8` APIs directly ([#12391](https://github.com/facebook/jest/pull/12391))
 - `[jest-snapshot]` [**BREAKING**] Migrate to ESM ([#12342](https://github.com/facebook/jest/pull/12342))
 - `[jest-transform]` Update `write-file-atomic` to v4 ([#12357](https://github.com/facebook/jest/pull/12357))
+- `[jest-types]` [**BREAKING**] Remove `Config.Glob` and `Config.Path` ([#12406](https://github.com/facebook/jest/pull/12406))
 - `[jest]` Use `index.ts` instead of `jest.ts` as main export ([#12329](https://github.com/facebook/jest/pull/12329))
 
 ### Performance

e2e/Utils.ts

@@ -20,7 +20,7 @@ interface RunResult extends ExecaReturnValue {
 }
 export const run = (
   cmd: string,
-  cwd?: Config.Path,
+  cwd?: string,
   env?: Record<string, string>,
 ): RunResult => {
   const args = cmd.split(/\s/).slice(1);
@@ -44,10 +44,7 @@ export const run = (
   return result;
 };
 
-export const runYarnInstall = (
-  cwd: Config.Path,
-  env?: Record<string, string>,
-) => {
+export const runYarnInstall = (cwd: string, env?: Record<string, string>) => {
   const lockfilePath = path.resolve(cwd, 'yarn.lock');
   let exists = true;
 
@@ -60,7 +57,7 @@ export const runYarnInstall = (
   return run(exists ? 'yarn install --immutable' : 'yarn install', cwd, env);
 };
 
-export const linkJestPackage = (packageName: string, cwd: Config.Path) => {
+export const linkJestPackage = (packageName: string, cwd: string) => {
   const packagesDir = path.resolve(__dirname, '../packages');
   const packagePath = path.resolve(packagesDir, packageName);
   const destination = path.resolve(cwd, 'node_modules/', packageName);
@@ -182,7 +179,7 @@ const DEFAULT_PACKAGE_JSON: JestPackageJson = {
 };
 
 export const createEmptyPackage = (
-  directory: Config.Path,
+  directory: string,
   packageJson: PackageJson = DEFAULT_PACKAGE_JSON,
 ) => {
   const packageJsonWithDefaults = {

packages/babel-jest/package.json

@@ -19,7 +19,6 @@
   },
   "dependencies": {
     "@jest/transform": "^28.0.0-alpha.1",
-    "@jest/types": "^28.0.0-alpha.1",
     "@types/babel__core": "^7.1.14",
     "babel-plugin-istanbul": "^6.1.1",
     "babel-preset-jest": "^28.0.0-alpha.0",

packages/babel-jest/src/index.ts

@@ -20,7 +20,6 @@ import type {
   TransformOptions as JestTransformOptions,
   SyncTransformer,
 } from '@jest/transform';
-import type {Config} from '@jest/types';
 import {loadPartialConfig, loadPartialConfigAsync} from './loadBabelConfig';
 
 const THIS_FILE = fs.readFileSync(__filename);
@@ -31,8 +30,8 @@ type CreateTransformer = SyncTransformer<TransformOptions>['createTransformer'];
 
 function assertLoadedBabelConfig(
   babelConfig: Readonly<PartialConfig> | null,
-  cwd: Config.Path,
-  filename: Config.Path,
+  cwd: string,
+  filename: string,
 ): asserts babelConfig {
   if (!babelConfig) {
     throw new Error(
@@ -72,7 +71,7 @@ function addIstanbulInstrumentation(
 
 function getCacheKeyFromConfig(
   sourceText: string,
-  sourcePath: Config.Path,
+  sourcePath: string,
   babelOptions: PartialConfig,
   transformOptions: JestTransformOptions,
 ): string {
@@ -104,8 +103,8 @@ function getCacheKeyFromConfig(
 }
 
 function loadBabelConfig(
-  cwd: Config.Path,
-  filename: Config.Path,
+  cwd: string,
+  filename: string,
   transformOptions: TransformOptions,
 ): PartialConfig {
   const babelConfig = loadPartialConfig(transformOptions);
@@ -116,8 +115,8 @@ function loadBabelConfig(
 }
 
 async function loadBabelConfigAsync(
-  cwd: Config.Path,
-  filename: Config.Path,
+  cwd: string,
+  filename: string,
   transformOptions: TransformOptions,
 ): Promise<PartialConfig> {
   const babelConfig = await loadPartialConfigAsync(transformOptions);
@@ -128,8 +127,8 @@ async function loadBabelConfigAsync(
 }
 
 function loadBabelOptions(
-  cwd: Config.Path,
-  filename: Config.Path,
+  cwd: string,
+  filename: string,
   transformOptions: TransformOptions,
   jestTransformOptions: JestTransformOptions,
 ): TransformOptions {
@@ -139,8 +138,8 @@ function loadBabelOptions(
 }
 
 async function loadBabelOptionsAsync(
-  cwd: Config.Path,
-  filename: Config.Path,
+  cwd: string,
+  filename: string,
   transformOptions: TransformOptions,
   jestTransformOptions: JestTransformOptions,
 ): Promise<TransformOptions> {
@@ -169,7 +168,7 @@ export const createTransformer: CreateTransformer = userOptions => {
   } as const;
 
   function mergeBabelTransformOptions(
-    filename: Config.Path,
+    filename: string,
     transformOptions: JestTransformOptions,
   ): TransformOptions {
     const {cwd} = transformOptions.config;

packages/babel-jest/tsconfig.json

@@ -7,9 +7,5 @@
   "include": ["./src/**/*"],
   "exclude": ["./**/__tests__/**/*"],
   // TODO: include `babel-preset-jest` if it's ever in TS even though we don't care about its types
-  "references": [
-    {"path": "../jest-transform"},
-    {"path": "../jest-types"},
-    {"path": "../test-utils"}
-  ]
+  "references": [{"path": "../jest-transform"}, {"path": "../test-utils"}]
 }

packages/expect/package.json

@@ -19,7 +19,6 @@
   },
   "dependencies": {
     "@jest/expect-utils": "^28.0.0-alpha.1",
-    "@jest/types": "^28.0.0-alpha.1",
     "jest-get-type": "^28.0.0-alpha.0",
     "jest-matcher-utils": "^28.0.0-alpha.1",
     "jest-message-util": "^28.0.0-alpha.1"

packages/expect/src/types.ts

@@ -7,7 +7,6 @@
  */
 
 import type {EqualsFunction, Tester} from '@jest/expect-utils';
-import type {Config} from '@jest/types';
 import type * as jestMatcherUtils from 'jest-matcher-utils';
 import {INTERNAL_MATCHER_FLAG} from './jestMatchersObject';
 
@@ -56,7 +55,7 @@ export interface MatcherState {
   isNot: boolean;
   promise: string;
   suppressedErrors: Array<Error>;
-  testPath?: Config.Path;
+  testPath?: string;
   utils: typeof jestMatcherUtils & {
     iterableEquality: Tester;
     subsetEquality: Tester;

packages/expect/tsconfig.json

@@ -11,7 +11,6 @@
     {"path": "../jest-get-type"},
     {"path": "../jest-matcher-utils"},
     {"path": "../jest-message-util"},
-    {"path": "../jest-types"},
     {"path": "../test-utils"}
   ]
 }

packages/jest-changed-files/package.json

@@ -17,7 +17,6 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@jest/types": "^28.0.0-alpha.1",
     "execa": "^5.0.0",
     "throat": "^6.0.1"
   },

packages/jest-changed-files/src/git.ts

@@ -8,13 +8,12 @@
 
 import * as path from 'path';
 import execa = require('execa');
-import type {Config} from '@jest/types';
 import type {SCMAdapter} from './types';
 
 const findChangedFilesUsingCommand = async (
   args: Array<string>,
-  cwd: Config.Path,
-): Promise<Array<Config.Path>> => {
+  cwd: string,
+): Promise<Array<string>> => {
   let result: execa.ExecaReturnValue;
 
   try {

packages/jest-changed-files/src/index.ts

@@ -7,7 +7,6 @@
  */
 
 import throat from 'throat';
-import type {Config} from '@jest/types';
 import git from './git';
 import hg from './hg';
 import type {ChangedFilesPromise, Options, Repos, SCMAdapter} from './types';
@@ -28,7 +27,7 @@ const findGitRoot = (dir: string) => mutex(() => git.getRoot(dir));
 const findHgRoot = (dir: string) => mutex(() => hg.getRoot(dir));
 
 export const getChangedFilesForRoots = async (
-  roots: Array<Config.Path>,
+  roots: Array<string>,
   options: Options,
 ): ChangedFilesPromise => {
   const repos = await findRepos(roots);
@@ -56,7 +55,7 @@ export const getChangedFilesForRoots = async (
   return {changedFiles, repos};
 };
 
-export const findRepos = async (roots: Array<Config.Path>): Promise<Repos> => {
+export const findRepos = async (roots: Array<string>): Promise<Repos> => {
   const gitRepos = await Promise.all(
     roots.reduce<Array<RootPromise>>(
       (promises, root) => promises.concat(findGitRoot(root)),

packages/jest-changed-files/src/types.ts

@@ -5,24 +5,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {Config} from '@jest/types';
-
 export type Options = {
   lastCommit?: boolean;
   withAncestor?: boolean;
   changedSince?: string;
-  includePaths?: Array<Config.Path>;
+  includePaths?: Array<string>;
 };
 
-type Paths = Set<Config.Path>;
+type Paths = Set<string>;
 export type Repos = {git: Paths; hg: Paths};
 export type ChangedFiles = {repos: Repos; changedFiles: Paths};
 export type ChangedFilesPromise = Promise<ChangedFiles>;
 
 export type SCMAdapter = {
-  findChangedFiles: (
-    cwd: Config.Path,
-    options: Options,
-  ) => Promise<Array<Config.Path>>;
-  getRoot: (cwd: Config.Path) => Promise<Config.Path | null>;
+  findChangedFiles: (cwd: string, options: Options) => Promise<Array<string>>;
+  getRoot: (cwd: string) => Promise<string | null>;
 };

packages/jest-changed-files/tsconfig.json

@@ -4,6 +4,5 @@
     "rootDir": "src",
     "outDir": "build"
   },
-  "include": ["./src/**/*"],
-  "references": [{"path": "../jest-types"}]
+  "include": ["./src/**/*"]
 }

packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapterInit.ts

@@ -54,8 +54,8 @@ export const initialize = async ({
   config: Config.ProjectConfig;
   environment: JestEnvironment;
   globalConfig: Config.GlobalConfig;
-  localRequire: <T = unknown>(path: Config.Path) => T;
-  testPath: Config.Path;
+  localRequire: <T = unknown>(path: string) => T;
+  testPath: string;
   parentProcess: Process;
   sendMessageToJest?: TestFileEvent;
   setGlobalsForRuntime: (globals: JestGlobals) => void;

packages/jest-cli/src/cli/index.ts

@@ -20,7 +20,7 @@ import * as args from './args';
 
 export async function run(
   maybeArgv?: Array<string>,
-  project?: Config.Path,
+  project?: string,
 ): Promise<void> {
   try {
     const argv = await buildArgv(maybeArgv);
@@ -85,10 +85,7 @@ export async function buildArgv(
   );
 }
 
-const getProjectListFromCLIArgs = (
-  argv: Config.Argv,
-  project?: Config.Path,
-) => {
+const getProjectListFromCLIArgs = (argv: Config.Argv, project?: string) => {
   const projects = argv.projects ? argv.projects : [];
 
   if (project) {

packages/jest-config/src/getCacheDirectory.ts

@@ -7,10 +7,9 @@
 
 import {tmpdir} from 'os';
 import * as path from 'path';
-import type {Config} from '@jest/types';
 import {tryRealpath} from 'jest-util';
 
-const getCacheDirectory: () => Config.Path = () => {
+const getCacheDirectory: () => string = () => {
   const {getuid} = process;
   const tmpdirPath = path.join(tryRealpath(tmpdir()), 'jest');
   if (getuid == null) {

packages/jest-config/src/index.ts

@@ -25,21 +25,21 @@ export {default as descriptions} from './Descriptions';
 export {constants};
 
 type ReadConfig = {
-  configPath: Config.Path | null | undefined;
+  configPath: string | null | undefined;
   globalConfig: Config.GlobalConfig;
   hasDeprecationWarnings: boolean;
   projectConfig: Config.ProjectConfig;
 };
 
 export async function readConfig(
   argv: Config.Argv,
-  packageRootOrConfig: Config.Path | Config.InitialOptions,
+  packageRootOrConfig: string | Config.InitialOptions,
   // Whether it needs to look into `--config` arg passed to CLI.
   // It only used to read initial config. If the initial config contains
   // `project` property, we don't want to read `--config` value and rather
   // read individual configs for every project.
   skipArgvConfigOption?: boolean,
-  parentConfigDirname?: Config.Path | null,
+  parentConfigDirname?: string | null,
   projectIndex = Infinity,
   skipMultipleConfigWarning = false,
 ): Promise<ReadConfig> {
@@ -278,7 +278,7 @@ This usually means that your ${chalk.bold(
 // (and only) project.
 export async function readConfigs(
   argv: Config.Argv,
-  projectPaths: Array<Config.Path>,
+  projectPaths: Array<string>,
 ): Promise<{
   globalConfig: Config.GlobalConfig;
   configs: Array<Config.ProjectConfig>;
@@ -288,7 +288,7 @@ export async function readConfigs(
   let hasDeprecationWarnings;
   let configs: Array<Config.ProjectConfig> = [];
   let projects = projectPaths;
-  let configPath: Config.Path | null | undefined;
+  let configPath: string | null | undefined;
 
   if (projectPaths.length === 1) {
     const parsedConfig = await readConfig(argv, projects[0]);

packages/jest-config/src/normalize.ts

@@ -54,7 +54,7 @@ type AllOptions = Config.ProjectConfig & Config.GlobalConfig;
 const createConfigError = (message: string) =>
   new ValidationError(ERROR, message, DOCUMENTATION_NOTE);
 
-function verifyDirectoryExists(path: Config.Path, key: string) {
+function verifyDirectoryExists(path: string, key: string) {
   try {
     const rootStat = statSync(path);
 
@@ -257,7 +257,7 @@ const normalizeCollectCoverageOnlyFrom = (
   key: keyof Pick<Config.InitialOptions, 'collectCoverageOnlyFrom'>,
 ) => {
   const initialCollectCoverageFrom = options[key];
-  const collectCoverageOnlyFrom: Array<Config.Glob> = Array.isArray(
+  const collectCoverageOnlyFrom: Array<string> = Array.isArray(
     initialCollectCoverageFrom,
   )
     ? initialCollectCoverageFrom // passed from argv
@@ -278,7 +278,7 @@ const normalizeCollectCoverageFrom = (
   key: keyof Pick<Config.InitialOptions, 'collectCoverageFrom'>,
 ) => {
   const initialCollectCoverageFrom = options[key];
-  let value: Array<Config.Glob> | undefined;
+  let value: Array<string> | undefined;
   if (!initialCollectCoverageFrom) {
     value = [];
   }
@@ -366,7 +366,7 @@ const normalizePreprocessor = (
 
 const normalizeMissingOptions = (
   options: Config.InitialOptionsWithRootDir,
-  configPath: Config.Path | null | undefined,
+  configPath: string | null | undefined,
   projectIndex: number,
 ): Config.InitialOptionsWithRootDir => {
   if (!options.name) {
@@ -550,7 +550,7 @@ function validateExtensionsToTreatAsEsm(
 export default async function normalize(
   initialOptions: Config.InitialOptions,
   argv: Config.Argv,
-  configPath?: Config.Path | null,
+  configPath?: string | null,
   projectIndex = Infinity,
 ): Promise<{
   hasDeprecationWarnings: boolean;