@ohos-ports/nx 19.8.4-beta.0

package/src/utils/package-json.d.ts

@@ -0,0 +1,103 @@
+import { NxJsonConfiguration } from '../config/nx-json';
+import { ProjectConfiguration, ProjectMetadata, TargetConfiguration } from '../config/workspace-json-project-json';
+import { PackageManagerCommands } from './package-manager';
+export interface NxProjectPackageJsonConfiguration extends Partial<ProjectConfiguration> {
+    includedScripts?: string[];
+}
+export type ArrayPackageGroup = {
+    package: string;
+    version: string;
+}[];
+export type MixedPackageGroup = (string | {
+    package: string;
+    version: string;
+})[] | Record<string, string>;
+export type PackageGroup = MixedPackageGroup | ArrayPackageGroup;
+export interface NxMigrationsConfiguration {
+    migrations?: string;
+    packageGroup?: PackageGroup;
+}
+type PackageOverride = {
+    [key: string]: string | PackageOverride;
+};
+export interface PackageJson {
+    name: string;
+    version: string;
+    license?: string;
+    private?: boolean;
+    scripts?: Record<string, string>;
+    type?: 'module' | 'commonjs';
+    main?: string;
+    types?: string;
+    module?: string;
+    exports?: string | Record<string, string | {
+        types?: string;
+        require?: string;
+        import?: string;
+    }>;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    optionalDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    peerDependenciesMeta?: Record<string, {
+        optional: boolean;
+    }>;
+    resolutions?: Record<string, string>;
+    pnpm?: {
+        overrides?: PackageOverride;
+    };
+    overrides?: PackageOverride;
+    bin?: Record<string, string> | string;
+    workspaces?: string[] | {
+        packages: string[];
+    };
+    publishConfig?: Record<string, string>;
+    nx?: NxProjectPackageJsonConfiguration;
+    generators?: string;
+    schematics?: string;
+    builders?: string;
+    executors?: string;
+    'nx-migrations'?: string | NxMigrationsConfiguration;
+    'ng-update'?: string | NxMigrationsConfiguration;
+    packageManager?: string;
+    description?: string;
+    keywords?: string[];
+}
+export declare function normalizePackageGroup(packageGroup: PackageGroup): ArrayPackageGroup;
+export declare function readNxMigrateConfig(json: Partial<PackageJson>): NxMigrationsConfiguration & {
+    packageGroup?: ArrayPackageGroup;
+};
+export declare function buildTargetFromScript(script: string, scripts: Record<string, string>, packageManagerCommand: PackageManagerCommands): TargetConfiguration;
+export declare function getMetadataFromPackageJson(packageJson: PackageJson): ProjectMetadata;
+export declare function getTagsFromPackageJson(packageJson: PackageJson): string[];
+export declare function readTargetsFromPackageJson(packageJson: PackageJson, nxJson: NxJsonConfiguration): Record<string, TargetConfiguration<any>>;
+/**
+ * Uses `require.resolve` to read the package.json for a module.
+ *
+ * This will fail if the module doesn't export package.json
+ *
+ * @returns package json contents and path
+ */
+export declare function readModulePackageJsonWithoutFallbacks(moduleSpecifier: string, requirePaths?: string[]): {
+    packageJson: PackageJson;
+    path: string;
+};
+/**
+ * Reads the package.json file for a specified module.
+ *
+ * Includes a fallback that accounts for modules that don't export package.json
+ *
+ * @param {string} moduleSpecifier The module to look up
+ * @param {string[]} requirePaths List of paths look in. Pass `module.paths` to ensure non-hoisted dependencies are found.
+ *
+ * @example
+ * // Use the caller's lookup paths for non-hoisted dependencies
+ * readModulePackageJson('http-server', module.paths);
+ *
+ * @returns package json contents and path
+ */
+export declare function readModulePackageJson(moduleSpecifier: string, requirePaths?: string[]): {
+    packageJson: PackageJson;
+    path: string;
+};
+export {};

package/src/utils/package-json.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePackageGroup = normalizePackageGroup;
+exports.readNxMigrateConfig = readNxMigrateConfig;
+exports.buildTargetFromScript = buildTargetFromScript;
+exports.getMetadataFromPackageJson = getMetadataFromPackageJson;
+exports.getTagsFromPackageJson = getTagsFromPackageJson;
+exports.readTargetsFromPackageJson = readTargetsFromPackageJson;
+exports.readModulePackageJsonWithoutFallbacks = readModulePackageJsonWithoutFallbacks;
+exports.readModulePackageJson = readModulePackageJson;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const project_configuration_utils_1 = require("../project-graph/utils/project-configuration-utils");
+const fileutils_1 = require("./fileutils");
+const installation_directory_1 = require("./installation-directory");
+const package_manager_1 = require("./package-manager");
+function normalizePackageGroup(packageGroup) {
+    return Array.isArray(packageGroup)
+        ? packageGroup.map((x) => typeof x === 'string' ? { package: x, version: '*' } : x)
+        : Object.entries(packageGroup).map(([pkg, version]) => ({
+            package: pkg,
+            version,
+        }));
+}
+function readNxMigrateConfig(json) {
+    const parseNxMigrationsConfig = (fromJson) => {
+        if (!fromJson) {
+            return {};
+        }
+        if (typeof fromJson === 'string') {
+            return { migrations: fromJson, packageGroup: [] };
+        }
+        return {
+            ...(fromJson.migrations ? { migrations: fromJson.migrations } : {}),
+            ...(fromJson.packageGroup
+                ? { packageGroup: normalizePackageGroup(fromJson.packageGroup) }
+                : {}),
+        };
+    };
+    return {
+        ...parseNxMigrationsConfig(json['ng-update']),
+        ...parseNxMigrationsConfig(json['nx-migrations']),
+        // In case there's a `migrations` field in `package.json`
+        ...parseNxMigrationsConfig(json),
+    };
+}
+function buildTargetFromScript(script, scripts = {}, packageManagerCommand) {
+    return {
+        executor: 'nx:run-script',
+        options: {
+            script,
+        },
+        metadata: {
+            scriptContent: scripts[script],
+            runCommand: packageManagerCommand.run(script),
+        },
+    };
+}
+let packageManagerCommand;
+function getMetadataFromPackageJson(packageJson) {
+    const { scripts, nx, description } = packageJson ?? {};
+    const includedScripts = nx?.includedScripts || Object.keys(scripts ?? {});
+    return {
+        targetGroups: {
+            ...(includedScripts.length ? { 'NPM Scripts': includedScripts } : {}),
+        },
+        description,
+    };
+}
+function getTagsFromPackageJson(packageJson) {
+    const tags = packageJson.private ? ['npm:private'] : ['npm:public'];
+    if (packageJson.keywords?.length) {
+        tags.push(...packageJson.keywords.map((k) => `npm:${k}`));
+    }
+    if (packageJson?.nx?.tags?.length) {
+        tags.push(...packageJson?.nx.tags);
+    }
+    return tags;
+}
+function readTargetsFromPackageJson(packageJson, nxJson) {
+    const { scripts, nx, private: isPrivate } = packageJson ?? {};
+    const res = {};
+    const includedScripts = nx?.includedScripts || Object.keys(scripts ?? {});
+    packageManagerCommand ??= (0, package_manager_1.getPackageManagerCommand)();
+    for (const script of includedScripts) {
+        res[script] = buildTargetFromScript(script, scripts, packageManagerCommand);
+    }
+    for (const targetName in nx?.targets) {
+        res[targetName] = (0, project_configuration_utils_1.mergeTargetConfigurations)(nx?.targets[targetName], res[targetName]);
+    }
+    /**
+     * Add implicit nx-release-publish target for all package.json files that are
+     * not marked as `"private": true` to allow for lightweight configuration for
+     * package based repos.
+     *
+     * Any targetDefaults for the nx-release-publish target set by the user should
+     * be merged with the implicit target.
+     */
+    if (!isPrivate && !res['nx-release-publish']) {
+        const nxReleasePublishTargetDefaults = nxJson?.targetDefaults?.['nx-release-publish'] ?? {};
+        res['nx-release-publish'] = {
+            executor: '@nx/js:release-publish',
+            ...nxReleasePublishTargetDefaults,
+            dependsOn: [
+                // For maximum correctness, projects should only ever be published once their dependencies are successfully published
+                '^nx-release-publish',
+                ...(nxReleasePublishTargetDefaults.dependsOn ?? []),
+            ],
+            options: {
+                ...(nxReleasePublishTargetDefaults.options ?? {}),
+            },
+        };
+    }
+    return res;
+}
+/**
+ * Uses `require.resolve` to read the package.json for a module.
+ *
+ * This will fail if the module doesn't export package.json
+ *
+ * @returns package json contents and path
+ */
+function readModulePackageJsonWithoutFallbacks(moduleSpecifier, requirePaths = (0, installation_directory_1.getNxRequirePaths)()) {
+    const packageJsonPath = require.resolve(`${moduleSpecifier}/package.json`, {
+        paths: requirePaths,
+    });
+    const packageJson = (0, fileutils_1.readJsonFile)(packageJsonPath);
+    return {
+        path: packageJsonPath,
+        packageJson,
+    };
+}
+/**
+ * Reads the package.json file for a specified module.
+ *
+ * Includes a fallback that accounts for modules that don't export package.json
+ *
+ * @param {string} moduleSpecifier The module to look up
+ * @param {string[]} requirePaths List of paths look in. Pass `module.paths` to ensure non-hoisted dependencies are found.
+ *
+ * @example
+ * // Use the caller's lookup paths for non-hoisted dependencies
+ * readModulePackageJson('http-server', module.paths);
+ *
+ * @returns package json contents and path
+ */
+function readModulePackageJson(moduleSpecifier, requirePaths = (0, installation_directory_1.getNxRequirePaths)()) {
+    let packageJsonPath;
+    let packageJson;
+    try {
+        ({ path: packageJsonPath, packageJson } =
+            readModulePackageJsonWithoutFallbacks(moduleSpecifier, requirePaths));
+    }
+    catch {
+        const entryPoint = require.resolve(moduleSpecifier, {
+            paths: requirePaths,
+        });
+        let moduleRootPath = (0, path_1.dirname)(entryPoint);
+        packageJsonPath = (0, path_1.join)(moduleRootPath, 'package.json');
+        while (!(0, fs_1.existsSync)(packageJsonPath)) {
+            moduleRootPath = (0, path_1.dirname)(moduleRootPath);
+            packageJsonPath = (0, path_1.join)(moduleRootPath, 'package.json');
+        }
+        packageJson = (0, fileutils_1.readJsonFile)(packageJsonPath);
+        if (packageJson.name && packageJson.name !== moduleSpecifier) {
+            throw new Error(`Found module ${packageJson.name} while trying to locate ${moduleSpecifier}/package.json`);
+        }
+    }
+    return {
+        packageJson,
+        path: packageJsonPath,
+    };
+}

package/src/utils/package-manager.d.ts

@@ -0,0 +1,100 @@
+export type PackageManager = 'yarn' | 'pnpm' | 'npm' | 'bun';
+export interface PackageManagerCommands {
+    preInstall?: string;
+    install: string;
+    ciInstall: string;
+    updateLockFile: string;
+    add: string;
+    addDev: string;
+    rm: string;
+    exec: string;
+    dlx: string;
+    list: string;
+    run: (script: string, args?: string) => string;
+    getRegistryUrl?: string;
+}
+/**
+ * Detects which package manager is used in the workspace based on the lock file.
+ */
+export declare function detectPackageManager(dir?: string): PackageManager;
+/**
+ * Returns true if the workspace is using npm workspaces, yarn workspaces, or pnpm workspaces.
+ * @param packageManager The package manager to use. If not provided, it will be detected based on the lock file.
+ * @param root The directory the commands will be ran inside of. Defaults to the current workspace's root.
+ */
+export declare function isWorkspacesEnabled(packageManager?: PackageManager, root?: string): boolean;
+/**
+ * Returns commands for the package manager used in the workspace.
+ * By default, the package manager is derived based on the lock file,
+ * but it can also be passed in explicitly.
+ *
+ * Example:
+ *
+ * ```javascript
+ * execSync(`${getPackageManagerCommand().addDev} my-dev-package`);
+ * ```
+ *
+ * @param packageManager The package manager to use. If not provided, it will be detected based on the lock file.
+ * @param root The directory the commands will be ran inside of. Defaults to the current workspace's root.
+ */
+export declare function getPackageManagerCommand(packageManager?: PackageManager, root?: string): PackageManagerCommands;
+/**
+ * Returns the version of the package manager used in the workspace.
+ * By default, the package manager is derived based on the lock file,
+ * but it can also be passed in explicitly.
+ */
+export declare function getPackageManagerVersion(packageManager?: PackageManager, cwd?: string): string;
+/**
+ * Checks for a project level npmrc file by crawling up the file tree until
+ * hitting a package.json file, as this is how npm finds them as well.
+ */
+export declare function findFileInPackageJsonDirectory(file: string, directory?: string): string | null;
+/**
+ * We copy yarnrc.yml to the temporary directory to ensure things like the specified
+ * package registry are still used. However, there are a few relative paths that can
+ * cause issues, so we modify them to fit the new directory.
+ *
+ * Exported for testing - not meant to be used outside of this file.
+ *
+ * @param contents The string contents of the yarnrc.yml file
+ * @returns Updated string contents of the yarnrc.yml file
+ */
+export declare function modifyYarnRcYmlToFitNewDirectory(contents: string): string;
+/**
+ * We copy .yarnrc to the temporary directory to ensure things like the specified
+ * package registry are still used. However, there are a few relative paths that can
+ * cause issues, so we modify them to fit the new directory.
+ *
+ * Exported for testing - not meant to be used outside of this file.
+ *
+ * @param contents The string contents of the yarnrc.yml file
+ * @returns Updated string contents of the yarnrc.yml file
+ */
+export declare function modifyYarnRcToFitNewDirectory(contents: string): string;
+export declare function copyPackageManagerConfigurationFiles(root: string, destination: string): void;
+/**
+ * Creates a temporary directory where you can run package manager commands safely.
+ *
+ * For cases where you'd want to install packages that require an `.npmrc` set up,
+ * this function looks up for the nearest `.npmrc` (if exists) and copies it over to the
+ * temp directory.
+ */
+export declare function createTempNpmDirectory(): {
+    dir: string;
+    cleanup: () => Promise<void>;
+};
+/**
+ * Returns the resolved version for a given package and version tag using the
+ * NPM registry (when using Yarn it will fall back to NPM to fetch the info).
+ */
+export declare function resolvePackageVersionUsingRegistry(packageName: string, version: string): Promise<string>;
+/**
+ * Return the resolved version for a given package and version tag using by
+ * installing it in a temporary directory and fetching the version from the
+ * package.json.
+ */
+export declare function resolvePackageVersionUsingInstallation(packageName: string, version: string): Promise<string>;
+export declare function packageRegistryView(pkg: string, version: string, args: string): Promise<string>;
+export declare function packageRegistryPack(cwd: string, pkg: string, version: string): Promise<{
+    tarballPath: string;
+}>;