UNPKG

@angular/cli

Version:
229 lines (228 loc) • 10.1 kB
/** * @license * Copyright Google LLC All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.dev/license */ import { ErrorInfo } from './error'; import { Logger } from './logger'; import { PackageManifest, PackageMetadata } from './package-metadata'; import { InstalledPackage } from './package-tree'; export declare function parseNpmLikeDependencies(stdout: string, logger?: Logger, options?: { workspacePackageName?: string; }): Map<string, InstalledPackage>; /** * Parses the output of `yarn list` (classic). * * The expected output is a JSON stream (JSONL), where each line is a JSON object. * The relevant object has a `type` of `'tree'` with a `data` property. * Yarn classic does not provide a path, so the `path` property will be `undefined`. * * ```json * {"type":"tree","data":{"trees":[{"name":"@angular/cli@18.0.0","children":[]}]}} * ``` * * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns A map of package names to their installed package details. */ export declare function parseYarnClassicDependencies(stdout: string, logger?: Logger): Map<string, InstalledPackage>; /** * Parses the output of `npm view` or a compatible command to get a package manifest. * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns The package manifest object. */ export declare function parseNpmLikeManifest(stdout: string, logger?: Logger): PackageManifest | null; /** * Parses the output of `npm view` or a compatible command to get package metadata. * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns The package metadata object. */ export declare function parseNpmLikeMetadata(stdout: string, logger?: Logger): PackageMetadata | null; /** * Parses the output of `yarn info` (classic) to get a package manifest. * * When `yarn info --verbose` is used, the output is a JSONL stream. This function * iterates through the lines to find the object with `type: 'inspect'` which contains * the package manifest. * * For non-verbose output, it falls back to parsing a single JSON object. * * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns The package manifest object, or `null` if not found. */ export declare function parseYarnClassicManifest(stdout: string, logger?: Logger): PackageManifest | null; /** * Parses the output of `yarn npm info` (modern yarn) to get a package manifest. * * Modern yarn silently falls back to `latest` when a requested dist-tag does not exist. * When `options.version` is a dist-tag (not a valid SemVer range), this parser verifies * that the tag exists in the `dist-tags` output field and resolves to the returned manifest * version. The `dist-tags` field is always stripped from the returned manifest. * * NOTE: This only handles the dist-tag case. The equivalent fallback for SemVer versions and * ranges is handled for all package managers by `PackageManager.getRegistryManifest`. * * @param stdout The standard output of the command. * @param logger An optional logger instance. * @param options Optional context including the requested version or dist-tag. * @returns The package manifest object, or `null` if not found or if the requested * dist-tag could not be verified. */ export declare function parseYarnModernManifest(stdout: string, logger?: Logger, options?: { version?: string; }): PackageManifest | null; /** * Parses the output of `yarn info` (classic) to get package metadata. * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns The package metadata object. */ export declare function parseYarnClassicMetadata(stdout: string, logger?: Logger): PackageMetadata | null; /** * Parses the `stdout` or `stderr` output of npm or pnpm to extract structured error information. * It is also used by `parseBunError` as a fallback for npm-compatible JSON error objects. * * This parser uses a multi-stage approach. It first attempts to parse the entire `output` as a * single JSON object, which is the standard for modern tools like pnpm and npm. If JSON * parsing fails, it falls back to a line-by-line regex-based approach to handle the plain * text output from older versions of npm. * * Example JSON output (pnpm): * ```json * { * "code": "E404", * "summary": "Not Found - GET https://registry.npmjs.org/@angular%2fnon-existent - Not found", * "detail": "The requested resource '@angular/non-existent@*' could not be found or you do not have permission to access it." * } * ``` * * Example text output (npm): * ``` * npm error code E404 * npm error 404 Not Found - GET https://registry.npmjs.org/@angular%2fnon-existent - Not found * ``` * * @param output The standard output or standard error of the command. * @param logger An optional logger instance. * @returns An `ErrorInfo` object if parsing is successful, otherwise `null`. */ export declare function parseNpmLikeError(output: string, logger?: Logger): ErrorInfo | null; /** * Parses the `stdout` or `stderr` output of yarn classic to extract structured error information. * * This parser first attempts to find an HTTP status code (e.g., 404, 401) in the verbose output. * If found, it returns a standardized error code (`E${statusCode}`). * If no HTTP status code is found, it falls back to parsing generic JSON error lines. * * Example verbose output (with HTTP status code): * ```json * {"type":"verbose","data":"Request \"https://registry.npmjs.org/@angular%2fnon-existent\" finished with status code 404."} * ``` * * Example generic JSON error output: * ```json * {"type":"error","data":"Received invalid response from npm."} * ``` * * @param output The standard output or standard error of the command. * @param logger An optional logger instance. * @returns An `ErrorInfo` object if parsing is successful, otherwise `null`. */ export declare function parseYarnClassicError(output: string, logger?: Logger): ErrorInfo | null; /** * Parses the `stdout` or `stderr` output of modern yarn (v2+) to extract structured error information. * * Modern yarn reports errors as JSON lines, one per message line, which may include ANSI color codes * or OSC 8 hyperlinks when colors are enabled (e.g., in CI). The first line holds the summary, and * registry errors include the HTTP status, which is returned as a standardized error code (`E${statusCode}`). * * Example output (`yarn npm info <missing-package> --json`): * ```json * {"type":"error","name":35,"displayName":"YN0035","indent":"","data":"Package not found"} * {"type":"error","name":35,"displayName":"YN0035","indent":"","data":" Response Code: 404 (Not Found)"} * ``` * * @param output The standard output or standard error of the command. * @param logger An optional logger instance. * @returns An `ErrorInfo` object if parsing is successful, otherwise `null`. */ export declare function parseYarnModernError(output: string, logger?: Logger): ErrorInfo | null; /** * Parses the `stdout` or `stderr` output of `bun` commands to extract structured error information. * * Handles flat JSON error payloads emitted on `stdout` by `bun pm view` (e.g., when a requested * version or dist-tag does not exist) as well as plain-text HTTP status errors emitted on `stderr` * (e.g., 404 Not Found). Other JSON error shapes are delegated to `parseNpmLikeError`. * * Example JSON error output: * ```json * { "error": "No matching version found", "version": "@angular/core@99.99.99" } * ``` * * Example plain-text error output: * ``` * 404 Not Found: https://registry.npmjs.org/@angular%2fnon-existent * ``` * * @param output The standard output or standard error of the command. * @param logger An optional logger instance. * @returns An `ErrorInfo` object if parsing is successful, otherwise `null`. */ export declare function parseBunError(output: string, logger?: Logger): ErrorInfo | null; /** * Parses the output of `bun pm ls`. * * Bun does not support JSON output for `pm ls`. The output is a tree structure: * ``` * /path/to/project node_modules (1084) * ├── @angular/core@20.3.15 * ├── rxjs @7.8.2 * └── zone.js @0.15.1 * ``` * * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns A map of package names to their installed package details. */ export declare function parseBunDependencies(stdout: string, logger?: Logger): Map<string, InstalledPackage>; /** * Parses the output of `yarn info --name-only --json`. * * The expected output is a JSON stream (JSONL) of strings. * Each string represents a package locator. * * ``` * "karma@npm:6.4.4" * "@angular/core@npm:20.3.15" * ``` * * @param stdout The standard output of the command. * @param logger An optional logger instance. * @returns A map of package names to their installed package details. */ export declare function parseYarnModernDependencies(stdout: string, logger?: Logger): Map<string, InstalledPackage>; /** * Parses the output of the pnpm minimum-release-age config command. * @param output The string output to parse (in minutes). * @param version The active package manager version string. * @returns The duration in milliseconds. */ export declare function parsePnpmReleaseAge(output: string, version: string): number; /** * Parses the output of the yarn npmMinimalAgeGate config command. * @param output The string output to parse (duration string or minutes). * @returns The duration in milliseconds. */ export declare function parseYarnReleaseAge(output: string, version: string): number; /** * Parses the output of the npm before config option. * Converts the absolute cutoff date into a relative age in milliseconds. * @param output The date string to parse. * @returns The age in milliseconds. */ export declare function parseNpmBeforeDate(output: string): number;