@codemod-utils/json/dist/json/read-package-json.d.ts

Utilities for handling JSON

import type { Options, PackageJson } from '../types/index.js';
/**
 * Reads `package.json` and returns the parsed JSON.
 *
 * @param options
 *
 * An object with `projectRoot`.
 *
 * @return
 *
 * A JSON that represents `package.json`.
 *
 * @example
 *
 * Check if the project, against which the codemod is run,
 * has `typescript` as a dependency.
 *
 * ```ts
 * const { dependencies, devDependencies } = readPackageJson({
 *   projectRoot,
 * });
 *
 * const projectDependencies = new Map([
 *   ...Object.entries(dependencies ?? {}),
 *   ...Object.entries(devDependencies ?? {}),
 * ]);
 *
 * const hasTypeScript = projectDependencies.has('typescript');
 * ```
 */
export declare function readPackageJson(options: Options): PackageJson;