@baicie/ncu 0.1.14 → 0.1.16

package/build/index.d.ts

@@ -1,233 +1,247 @@
-import { SemVer } from 'semver-utils';
-
-/** A function that can be provided to the --cooldown option for custom cooldown predicate. */
-declare type CooldownFunction = (packageName: string) => number | null;
-
-/**
- * TypeScript helper for .npmrc config file. Similar to vite and eslint's
- * defineConfig helper
- */
-export declare function defineConfig(config: RcOptions): RcOptions;
-
-/** Supported function for the --filter and --reject options. */
-declare type FilterFunction = (packageName: string, versionRange: SemVer[]) => boolean;
-
-declare type FilterResultsFunction = (packageName: string, versioningMetadata: {
-    currentVersion: VersionSpec;
-    currentVersionSemver: SemVer[];
-    upgradedVersion: Version;
-    upgradedVersionSemver: SemVer;
-}) => boolean;
-
-/** Customize how packages are divided into groups when using `--format group`. Run "ncu --help --groupFunction" for details. */
-declare type GroupFunction = (packageName: string, defaultGroup: UpgradeGroup, currentVersionSpec: SemVer[], upgradedVersionSpec: SemVer[], upgradedVersion: SemVer | null) => UpgradeGroup | string;
-
-/** A very generic object. */
-declare type Index<T = any> = Record<string, T>;
-
-declare type NestedVersionSpecs = {
-    [name: string]: VersionSpec | NestedVersionSpecs;
-};
-
-/** Options that would make no sense in a .ncurc file */
-declare type Nonsensical = 'configFileName' | 'configFilePath' | 'cwd' | 'packageData' | 'stdin';
-
-/** The relevant bits of a parsed package.json file. */
-declare interface PackageFile {
-    dependencies?: Index<VersionSpec>;
-    devDependencies?: Index<VersionSpec>;
-    imports?: Index<VersionSpec>;
-    engines?: Index<VersionSpec>;
-    name?: string;
-    packageManager?: string;
-    optionalDependencies?: Index<VersionSpec>;
-    overrides?: NestedVersionSpecs;
-    peerDependencies?: Index<VersionSpec>;
-    repository?: string | PackageFileRepository;
-    scripts?: Index<string>;
-    workspaces?: string[] | {
-        packages: string[];
-    };
-    version?: string;
-}
-
-/** Represents the repository field in package.json. */
-declare interface PackageFileRepository {
-    url: string;
-    directory?: string;
-}
-
-/** Expected options that might be found in an .ncurc file. Since the config is external, this cannot be guaranteed */
-export declare type RcOptions = Omit<RunOptions, Nonsensical> & {
-    $schema?: string;
-    format?: string | string[];
-};
-
-/** Main entry point.
- *
- * @returns Promise<
- * PackageFile                    Default returns upgraded package file.
- * | Index<VersionSpec>    --jsonUpgraded returns only upgraded dependencies.
- * | void                         --global upgrade returns void.
- * >
- */
-declare function run_2(runOptions?: RunOptions, { cli }?: {
-    cli?: boolean;
-}): Promise<PackageFile | Index<VersionSpec> | void>;
-export default run_2;
-export { run_2 as run }
-
-/** Options that can be given on the CLI or passed to the ncu module to control all behavior. */
-export declare interface RunOptions {
-    /** Cache versions to a local cache file. Default `--cacheFile` is ~/.ncu-cache.json and default `--cacheExpiration` is 10 minutes. */
-    cache?: boolean;
-    /** Clear the default cache, or the cache file specified by `--cacheFile`. */
-    cacheClear?: boolean;
-    /** Cache expiration in minutes. Only works with `--cache`.
-     *
-     * @default 10
-     */
-    cacheExpiration?: number;
-    /** Filepath for the cache file. Only works with `--cache`.
-     *
-     * @default "~/.ncu-cache.json"
-     */
-    cacheFile?: string;
-    /** Force color in terminal. */
-    color?: boolean;
-    /** Max number of concurrent HTTP requests to registry.
-     *
-     * @default 8
-     */
-    concurrency?: number;
-    /** Config file name. (default: .ncurc.{json,yml,js,cjs}) */
-    configFileName?: string;
-    /** Directory of .ncurc config file. (default: directory of `packageFile`) */
-    configFilePath?: string;
-    /** Sets a minimum age (in days) for package versions to be considered for upgrade, reducing the risk of installing newly published, potentially compromised packages. Run "ncu --help --cooldown" for details. */
-    cooldown?: number | CooldownFunction;
-    /** Working directory in which npm will be executed. */
-    cwd?: string;
-    /** Run recursively in current working directory. Alias of (`--packageFile '**\/package.json'`). */
-    deep?: boolean;
-    /** Check one or more sections of dependencies only: dev, optional, peer, prod, or packageManager (comma-delimited).
-     *
-     * @default ["prod","dev","optional","packageManager"]
-     */
-    dep?: string | readonly string[];
-    /** Include deprecated packages. Use `--no-deprecated` to exclude deprecated packages (20–25% slower).
-     *
-     * @default true
-     */
-    deprecated?: boolean;
-    /** Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires `-u` to execute. Run "ncu --help --doctor" for details. */
-    doctor?: boolean;
-    /** Specifies the install script to use in doctor mode. (default: `npm install` or the equivalent for your package manager) */
-    doctorInstall?: string;
-    /** Specifies the test script to use in doctor mode. (default: `npm test`) */
-    doctorTest?: string;
-    /** Include only packages that satisfy engines.node as specified in the package file. */
-    enginesNode?: boolean;
-    /** Set the error level. 1: exits with error code 0 if no errors occur. 2: exits with error code 0 if no packages need updating (useful for continuous integration).
-     *
-     * @default 1
-     */
-    errorLevel?: number;
-    /** Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --filter" for details. */
-    filter?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
-    /** Filters results based on a user provided predicate function after fetching new versions. Run "ncu --help --filterResults" for details. */
-    filterResults?: FilterResultsFunction;
-    /** Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --filterVersion" for details. */
-    filterVersion?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
-    /** Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion. Run "ncu --help --format" for details. */
-    format?: readonly string[];
-    /** Check global packages instead of in the current project. */
-    global?: boolean;
-    /** Customize how packages are divided into groups when using `--format group`. Run "ncu --help --groupFunction" for details. */
-    groupFunction?: GroupFunction;
-    /** Ignore directories containing package.json files (comma-delimited). */
-    ignoreDirs?: string | readonly string[];
-    /** Control the auto-install behavior: always, never, prompt. Run "ncu --help --install" for details.
-     *
-     * @default "prompt"
-     */
-    install?: 'always' | 'never' | 'prompt';
-    /** Enable interactive prompts for each dependency; implies `-u` unless one of the json options are set. */
-    interactive?: boolean;
-    /** Output new package file instead of human-readable message. */
-    jsonAll?: boolean;
-    /** Like `jsonAll` but only lists `dependencies`, `devDependencies`, `optionalDependencies`, etc of the new package data. */
-    jsonDeps?: boolean;
-    /** Output upgraded dependencies in json. */
-    jsonUpgraded?: boolean;
-    /** Amount to log: silent, error, minimal, warn, info, verbose, silly.
-     *
-     * @default "warn"
-     */
-    loglevel?: string;
-    /** Merges nested configs with the root config file for `--deep` or `--packageFile` options. (default: false) */
-    mergeConfig?: boolean;
-    /** Do not upgrade newer versions that are already satisfied by the version range according to semver. */
-    minimal?: boolean;
-    /** Package file data (you can also use stdin). */
-    packageData?: string | PackageFile;
-    /** Package file(s) location. (default: ./package.json) */
-    packageFile?: string;
-    /** npm, yarn, pnpm, deno, bun, staticRegistry (default: npm). Run "ncu --help --packageManager" for details. */
-    packageManager?: 'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun' | 'staticRegistry';
-    /** Check peer dependencies of installed packages and filter updates to compatible versions. Run "ncu --help --peer" for details. */
-    peer?: boolean;
-    /** Include prerelease versions, e.g. -alpha.0, -beta.5, -rc.2. Automatically set to 1 when `--target` is newest or greatest, or when the current version is a prerelease. (default: 0) */
-    pre?: boolean;
-    /** Current working directory of npm. */
-    prefix?: string;
-    /** Specify the registry to use when looking up package versions. */
-    registry?: string;
-    /** Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm) Run "ncu --help --registryType" for details. */
-    registryType?: 'npm' | 'json';
-    /** Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --reject" for details. */
-    reject?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
-    /** Exclude package.json versions using comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --rejectVersion" for details. */
-    rejectVersion?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
-    /** Remove version ranges from the final package version. */
-    removeRange?: boolean;
-    /** Number of times to retry failed requests for package info.
-     *
-     * @default 3
-     */
-    retry?: number;
-    /** Runs updates on the root project in addition to specified workspaces. Only allowed with `--workspace` or `--workspaces`.
-     *
-     * @default true
-     */
-    root?: boolean;
-    /** Don't output anything. Alias for `--loglevel` silent. */
-    silent?: boolean;
-    /** Read package.json from stdin. */
-    stdin?: string;
-    /** Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, `@[tag]`, or [function]. (default: latest) Run "ncu --help --target" for details. */
-    target?: 'latest' | 'newest' | 'greatest' | 'minor' | 'patch' | 'semver' | `@${string}` | TargetFunction;
-    /** Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch) */
-    timeout?: number;
-    /** Overwrite package file with upgraded versions instead of just outputting to console. */
-    upgrade?: boolean;
-    /** Log additional information for debugging. Alias for `--loglevel` verbose. */
-    verbose?: boolean;
-    /** Run on one or more specified workspaces. Add `--no-root` to exclude the root project. */
-    workspace?: readonly string[];
-    /** Run on all workspaces. Add `--no-root` to exclude the root project. */
-    workspaces?: boolean;
-}
-
-/** A function that can be provided to the --target option for custom filtering. */
-declare type TargetFunction = (packageName: string, versionRange: SemVer[]) => string;
-
-declare type UpgradeGroup = 'major' | 'minor' | 'patch' | 'majorVersionZero' | 'none';
-
-/** An exact version number or value. Includes SemVer and some nonstandard variants for convenience. */
-declare type Version = string;
-
-/** A version specification or range supported as a value in package.json dependencies. Includes SemVer, git urls, npm urls, etc. */
-declare type VersionSpec = string;
-
-export { }
+import { SemVer } from "semver-utils";
+
+//#region src/types/IndexType.d.ts
+/** A very generic object. */
+type Index<T = any> = Record<string, T>;
+//#endregion
+//#region src/types/PackageFileRepository.d.ts
+/** Represents the repository field in package.json. */
+interface PackageFileRepository {
+  url: string;
+  directory?: string;
+}
+//#endregion
+//#region src/types/VersionSpec.d.ts
+/** A version specification or range supported as a value in package.json dependencies. Includes SemVer, git urls, npm urls, etc. */
+type VersionSpec = string;
+//#endregion
+//#region src/types/PackageFile.d.ts
+type NestedVersionSpecs = {
+  [name: string]: VersionSpec | NestedVersionSpecs;
+};
+/** The relevant bits of a parsed package.json file. */
+interface PackageFile {
+  dependencies?: Index<VersionSpec>;
+  devDependencies?: Index<VersionSpec>;
+  imports?: Index<VersionSpec>;
+  engines?: Index<VersionSpec>;
+  name?: string;
+  packageManager?: string;
+  optionalDependencies?: Index<VersionSpec>;
+  overrides?: NestedVersionSpecs;
+  peerDependencies?: Index<VersionSpec>;
+  repository?: string | PackageFileRepository;
+  scripts?: Index<string>;
+  workspaces?: string[] | {
+    packages: string[];
+  };
+  version?: string;
+}
+//#endregion
+//#region src/types/CooldownFunction.d.ts
+/** A function that can be provided to the --cooldown option for custom cooldown predicate. */
+type CooldownFunction = (packageName: string) => number | null;
+//#endregion
+//#region src/types/FilterFunction.d.ts
+/** Supported function for the --filter and --reject options. */
+type FilterFunction = (packageName: string, versionRange: SemVer[]) => boolean;
+//#endregion
+//#region src/types/Version.d.ts
+/** An exact version number or value. Includes SemVer and some nonstandard variants for convenience. */
+type Version = string;
+//#endregion
+//#region src/types/FilterResultsFunction.d.ts
+type FilterResultsFunction = (packageName: string, versioningMetadata: {
+  currentVersion: VersionSpec;
+  currentVersionSemver: SemVer[];
+  upgradedVersion: Version;
+  upgradedVersionSemver: SemVer;
+}) => boolean;
+//#endregion
+//#region src/types/UpgradeGroup.d.ts
+type UpgradeGroup = 'major' | 'minor' | 'patch' | 'majorVersionZero' | 'none';
+//#endregion
+//#region src/types/GroupFunction.d.ts
+/** Customize how packages are divided into groups when using `--format group`. Run "ncu --help --groupFunction" for details. */
+type GroupFunction = (packageName: string, defaultGroup: UpgradeGroup, currentVersionSpec: SemVer[], upgradedVersionSpec: SemVer[], upgradedVersion: SemVer | null) => UpgradeGroup | string;
+//#endregion
+//#region src/types/TargetFunction.d.ts
+/** A function that can be provided to the --target option for custom filtering. */
+type TargetFunction = (packageName: string, versionRange: SemVer[]) => string;
+//#endregion
+//#region src/types/RunOptions.d.ts
+/** Options that can be given on the CLI or passed to the ncu module to control all behavior. */
+interface RunOptions {
+  /** Cache versions to a local cache file. Default `--cacheFile` is ~/.ncu-cache.json and default `--cacheExpiration` is 10 minutes. */
+  cache?: boolean;
+  /** Clear the default cache, or the cache file specified by `--cacheFile`. */
+  cacheClear?: boolean;
+  /** Cache expiration in minutes. Only works with `--cache`.
+   *
+   * @default 10
+   */
+  cacheExpiration?: number;
+  /** Filepath for the cache file. Only works with `--cache`.
+   *
+   * @default "~/.ncu-cache.json"
+   */
+  cacheFile?: string;
+  /** Force color in terminal. */
+  color?: boolean;
+  /** Max number of concurrent HTTP requests to registry.
+   *
+   * @default 8
+   */
+  concurrency?: number;
+  /** Config file name. (default: .ncurc.{json,yml,js,cjs}) */
+  configFileName?: string;
+  /** Directory of .ncurc config file. (default: directory of `packageFile`) */
+  configFilePath?: string;
+  /** Sets a minimum age (in days) for package versions to be considered for upgrade, reducing the risk of installing newly published, potentially compromised packages. Run "ncu --help --cooldown" for details. */
+  cooldown?: number | CooldownFunction;
+  /** Working directory in which npm will be executed. */
+  cwd?: string;
+  /** Run recursively in current working directory. Alias of (`--packageFile '**\/package.json'`). */
+  deep?: boolean;
+  /** Check one or more sections of dependencies only: dev, optional, peer, prod, or packageManager (comma-delimited).
+   *
+   * @default ["prod","dev","optional","packageManager"]
+   */
+  dep?: string | readonly string[];
+  /** Include deprecated packages. Use `--no-deprecated` to exclude deprecated packages (20–25% slower).
+   *
+   * @default true
+   */
+  deprecated?: boolean;
+  /** Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires `-u` to execute. Run "ncu --help --doctor" for details. */
+  doctor?: boolean;
+  /** Specifies the install script to use in doctor mode. (default: `npm install` or the equivalent for your package manager) */
+  doctorInstall?: string;
+  /** Specifies the test script to use in doctor mode. (default: `npm test`) */
+  doctorTest?: string;
+  /** Include only packages that satisfy engines.node as specified in the package file. */
+  enginesNode?: boolean;
+  /** Set the error level. 1: exits with error code 0 if no errors occur. 2: exits with error code 0 if no packages need updating (useful for continuous integration).
+   *
+   * @default 1
+   */
+  errorLevel?: number;
+  /** Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --filter" for details. */
+  filter?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
+  /** Filters results based on a user provided predicate function after fetching new versions. Run "ncu --help --filterResults" for details. */
+  filterResults?: FilterResultsFunction;
+  /** Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --filterVersion" for details. */
+  filterVersion?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
+  /** Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion. Run "ncu --help --format" for details. */
+  format?: readonly string[];
+  /** Check global packages instead of in the current project. */
+  global?: boolean;
+  /** Customize how packages are divided into groups when using `--format group`. Run "ncu --help --groupFunction" for details. */
+  groupFunction?: GroupFunction;
+  /** Ignore directories containing package.json files (comma-delimited). */
+  ignoreDirs?: string | readonly string[];
+  /** Control the auto-install behavior: always, never, prompt. Run "ncu --help --install" for details.
+   *
+   * @default "prompt"
+   */
+  install?: 'always' | 'never' | 'prompt';
+  /** Enable interactive prompts for each dependency; implies `-u` unless one of the json options are set. */
+  interactive?: boolean;
+  /** Output new package file instead of human-readable message. */
+  jsonAll?: boolean;
+  /** Like `jsonAll` but only lists `dependencies`, `devDependencies`, `optionalDependencies`, etc of the new package data. */
+  jsonDeps?: boolean;
+  /** Output upgraded dependencies in json. */
+  jsonUpgraded?: boolean;
+  /** Amount to log: silent, error, minimal, warn, info, verbose, silly.
+   *
+   * @default "warn"
+   */
+  loglevel?: string;
+  /** Merges nested configs with the root config file for `--deep` or `--packageFile` options. (default: false) */
+  mergeConfig?: boolean;
+  /** Do not upgrade newer versions that are already satisfied by the version range according to semver. */
+  minimal?: boolean;
+  /** Package file data (you can also use stdin). */
+  packageData?: string | PackageFile;
+  /** Package file(s) location. (default: ./package.json) */
+  packageFile?: string;
+  /** npm, yarn, pnpm, deno, bun, staticRegistry (default: npm). Run "ncu --help --packageManager" for details. */
+  packageManager?: 'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun' | 'staticRegistry';
+  /** Check peer dependencies of installed packages and filter updates to compatible versions. Run "ncu --help --peer" for details. */
+  peer?: boolean;
+  /** Include prerelease versions, e.g. -alpha.0, -beta.5, -rc.2. Automatically set to 1 when `--target` is newest or greatest, or when the current version is a prerelease. (default: 0) */
+  pre?: boolean;
+  /** Current working directory of npm. */
+  prefix?: string;
+  /** Specify the registry to use when looking up package versions. */
+  registry?: string;
+  /** Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm) Run "ncu --help --registryType" for details. */
+  registryType?: 'npm' | 'json';
+  /** Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --reject" for details. */
+  reject?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
+  /** Exclude package.json versions using comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --rejectVersion" for details. */
+  rejectVersion?: string | RegExp | readonly (string | RegExp)[] | FilterFunction;
+  /** Remove version ranges from the final package version. */
+  removeRange?: boolean;
+  /** Number of times to retry failed requests for package info.
+   *
+   * @default 3
+   */
+  retry?: number;
+  /** Runs updates on the root project in addition to specified workspaces. Only allowed with `--workspace` or `--workspaces`.
+   *
+   * @default true
+   */
+  root?: boolean;
+  /** Don't output anything. Alias for `--loglevel` silent. */
+  silent?: boolean;
+  /** Read package.json from stdin. */
+  stdin?: string;
+  /** Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, `@[tag]`, or [function]. (default: latest) Run "ncu --help --target" for details. */
+  target?: 'latest' | 'newest' | 'greatest' | 'minor' | 'patch' | 'semver' | `@${string}` | TargetFunction;
+  /** Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch) */
+  timeout?: number;
+  /** Overwrite package file with upgraded versions instead of just outputting to console. */
+  upgrade?: boolean;
+  /** Log additional information for debugging. Alias for `--loglevel` verbose. */
+  verbose?: boolean;
+  /** Run on one or more specified workspaces. Add `--no-root` to exclude the root project. */
+  workspace?: readonly string[];
+  /** Run on all workspaces. Add `--no-root` to exclude the root project. */
+  workspaces?: boolean;
+}
+//#endregion
+//#region src/types/RcOptions.d.ts
+/** Options that would make no sense in a .ncurc file */
+type Nonsensical = 'configFileName' | 'configFilePath' | 'cwd' | 'packageData' | 'stdin';
+/** Expected options that might be found in an .ncurc file. Since the config is external, this cannot be guaranteed */
+type RcOptions = Omit<RunOptions, Nonsensical> & {
+  $schema?: string;
+  format?: string | string[];
+};
+//#endregion
+//#region src/lib/defineConfig.d.ts
+/**
+ * TypeScript helper for .npmrc config file. Similar to vite and eslint's
+ * defineConfig helper
+ */
+declare function defineConfig(config: RcOptions): RcOptions;
+//#endregion
+//#region src/index.d.ts
+/** Main entry point.
+ *
+ * @returns Promise<
+ * PackageFile                    Default returns upgraded package file.
+ * | Index<VersionSpec>    --jsonUpgraded returns only upgraded dependencies.
+ * | void                         --global upgrade returns void.
+ * >
+ */
+declare function run(runOptions?: RunOptions, {
+  cli
+}?: {
+  cli?: boolean;
+}): Promise<PackageFile | Index<VersionSpec> | void>;
+//#endregion
+export { type RcOptions, type RunOptions, run as default, run, defineConfig };
+//# sourceMappingURL=index.d.ts.map