@pkg-nec/jest-config 30.4.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+Copyright Contributors to the Jest project.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build/index.d.ts

@@ -0,0 +1,201 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {Config} from '@pkg-nec/jest-types';
+import {DeprecatedOptions} from '@pkg-nec/jest-validate';
+
+declare type AllOptions = Config.ProjectConfig & Config.GlobalConfig;
+
+declare namespace constants {
+  export {
+    NODE_MODULES,
+    DEFAULT_JS_PATTERN,
+    PACKAGE_JSON,
+    JEST_CONFIG_BASE_NAME,
+    JEST_CONFIG_EXT_CJS,
+    JEST_CONFIG_EXT_MJS,
+    JEST_CONFIG_EXT_MTS,
+    JEST_CONFIG_EXT_JS,
+    JEST_CONFIG_EXT_TS,
+    JEST_CONFIG_EXT_CTS,
+    JEST_CONFIG_EXT_JSON,
+    JEST_CONFIG_EXT_ORDER,
+  };
+}
+export {constants};
+
+declare const DEFAULT_JS_PATTERN = '\\.[jt]sx?$';
+
+export declare const defaults: Config.DefaultOptions;
+
+/**
+ * Type helper to make it easier to use Jest config accepts a direct JestTestConfigObject object, or a function that returns it. The function receives a JestTestConfigObject object.
+ */
+export declare function defineConfig(
+  config: JestTestConfigObject,
+): JestTestConfigObject;
+
+export declare function defineConfig(
+  config: Promise<JestTestConfigObject>,
+): Promise<JestTestConfigObject>;
+
+export declare function defineConfig(
+  config: UserConfigFnObject,
+): UserConfigFnObject;
+
+export declare function defineConfig(
+  config: UserConfigFnPromise,
+): UserConfigFnPromise;
+
+export declare function defineConfig(config: UserConfigFn): UserConfigFn;
+
+export declare const deprecationEntries: DeprecatedOptions;
+
+export declare const descriptions: {
+  [key in keyof Config.InitialOptions]: string;
+};
+
+export declare const isJSONString: (
+  text?: JSONString | string,
+) => text is JSONString;
+
+declare const JEST_CONFIG_BASE_NAME = 'jest.config';
+
+declare const JEST_CONFIG_EXT_CJS = '.cjs';
+
+declare const JEST_CONFIG_EXT_CTS = '.cts';
+
+declare const JEST_CONFIG_EXT_JS = '.js';
+
+declare const JEST_CONFIG_EXT_JSON = '.json';
+
+declare const JEST_CONFIG_EXT_MJS = '.mjs';
+
+declare const JEST_CONFIG_EXT_MTS = '.mts';
+
+declare const JEST_CONFIG_EXT_ORDER: ReadonlyArray<string>;
+
+declare const JEST_CONFIG_EXT_TS = '.ts';
+
+declare type JestTestConfigObject = Config.InitialOptions;
+
+declare type JSONString = string & {
+  readonly $$type: never;
+};
+
+/**
+ * Merges two configuration objects, where the second object takes precedence over the first one.
+ */
+export declare function mergeConfig<
+  D extends UserConfigExport,
+  O extends UserConfigExport,
+>(
+  defaults: D extends Function ? never : D,
+  overrides: O extends Function ? never : O,
+): JestTestConfigObject;
+
+declare const NODE_MODULES: string;
+
+export declare function normalize(
+  initialOptions: Config.InitialOptions,
+  argv: Config.Argv,
+  configPath?: string | null,
+  projectIndex?: number,
+  isProjectOptions?: boolean,
+): Promise<{
+  hasDeprecationWarnings: boolean;
+  options: AllOptions;
+}>;
+
+declare const PACKAGE_JSON = 'package.json';
+
+declare type ReadConfig = {
+  configPath: string | null | undefined;
+  globalConfig: Config.GlobalConfig;
+  hasDeprecationWarnings: boolean;
+  projectConfig: Config.ProjectConfig;
+};
+
+export declare function readConfig(
+  argv: Config.Argv,
+  packageRootOrConfig: string | Config.InitialOptions,
+  skipArgvConfigOption?: boolean,
+  parentConfigDirname?: string | null,
+  projectIndex?: number,
+  skipMultipleConfigError?: boolean,
+): Promise<ReadConfig>;
+
+export declare function readConfigs(
+  argv: Config.Argv,
+  projectPaths: Array<string>,
+): Promise<{
+  globalConfig: Config.GlobalConfig;
+  configs: Array<Config.ProjectConfig>;
+  hasDeprecationWarnings: boolean;
+}>;
+
+/**
+ * Reads the jest config, without validating them or filling it out with defaults.
+ * @param config The path to the file or serialized config.
+ * @param param1 Additional options
+ * @returns The raw initial config (not validated)
+ */
+export declare function readInitialOptions(
+  config?: string,
+  {
+    packageRootOrConfig,
+    parentConfigDirname,
+    readFromCwd,
+    skipMultipleConfigError,
+  }?: ReadJestConfigOptions,
+): Promise<{
+  config: Config.InitialOptions;
+  configPath: string | null;
+}>;
+
+export declare interface ReadJestConfigOptions {
+  /**
+   * The package root or deserialized config (default is cwd)
+   */
+  packageRootOrConfig?: string | Config.InitialOptions;
+  /**
+   * When the `packageRootOrConfig` contains config, this parameter should
+   * contain the dirname of the parent config
+   */
+  parentConfigDirname?: null | string;
+  /**
+   * Indicates whether or not to read the specified config file from disk.
+   * When true, jest will read try to read config from the current working directory.
+   * (default is false)
+   */
+  readFromCwd?: boolean;
+  /**
+   * Indicates whether or not to ignore the error of jest finding multiple config files.
+   * (default is false)
+   */
+  skipMultipleConfigError?: boolean;
+}
+
+export declare const replaceRootDirInPath: (
+  rootDir: string,
+  filePath: string,
+) => string;
+
+declare type UserConfigExport =
+  | JestTestConfigObject
+  | Promise<JestTestConfigObject>
+  | UserConfigFnObject
+  | UserConfigFnPromise
+  | UserConfigFn;
+
+declare type UserConfigFn = () =>
+  | JestTestConfigObject
+  | Promise<JestTestConfigObject>;
+
+declare type UserConfigFnObject = () => JestTestConfigObject;
+
+declare type UserConfigFnPromise = () => Promise<JestTestConfigObject>;