pnpm-settings-migrator 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT ntnyq <https://github.com/ntnyq>
+
+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/README.md

@@ -0,0 +1,30 @@
+# pnpm-settings-migrator
+
+[![CI](https://github.com/ntnyq/pnpm-settings-migrator/workflows/CI/badge.svg)](https://github.com/ntnyq/pnpm-settings-migrator/actions)
+[![NPM VERSION](https://img.shields.io/npm/v/pnpm-settings-migrator.svg)](https://www.npmjs.com/package/pnpm-settings-migrator)
+[![NPM DOWNLOADS](https://img.shields.io/npm/dy/pnpm-settings-migrator.svg)](https://www.npmjs.com/package/pnpm-settings-migrator)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/pnpm-settings-migrator.svg)](https://github.com/ntnyq/pnpm-settings-migrator/blob/main/LICENSE)
+
+Move pnpm settings from `pnpm` field in `package.json` and `.npmrc` file to `pnpm-workspace.yaml`.
+
+## Usage
+
+Run in your workspace root:
+
+```shell
+pnpm dlx pnpm-settings-migrator
+```
+
+## CLI Options
+
+| Option |   Type   |     Default     |        Description        |
+| :----: | :------: | :-------------: | :-----------------------: |
+| `cwd`  | `string` | `process.cwd()` | Current working directory |
+
+## Context
+
+- [Moving settings to pnpm-workspace.yaml](https://github.com/orgs/pnpm/discussions/9037)
+
+## License
+
+[MIT](./LICENSE) License © 2025-PRESENT [ntnyq](https://github.com/ntnyq)

package/bin.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict'
+
+import('./dist/cli.mjs')

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.mjs

@@ -0,0 +1,38 @@
+import process from 'node:process';
+import { cac } from 'cac';
+import { consola } from 'consola';
+import { getColor } from 'consola/utils';
+import { m as migratePnpmSettings } from './shared/pnpm-settings-migrator.BiiS7DGq.mjs';
+import '@ntnyq/utils';
+import 'pathe';
+import 'node:fs/promises';
+import 'js-yaml';
+import 'camelcase-keys';
+import 'read-ini-file';
+
+const name = "pnpm-settings-migrator";
+const version = "0.0.1";
+
+const dim = getColor("dim");
+const green = getColor("green");
+const red = getColor("red");
+const bold = getColor("bold");
+const magenta = getColor("magenta");
+const cli = cac(name);
+cli.version(version).option("--cwd [cwd]", "Current working directory").help();
+cli.command("").action(async (options) => {
+  try {
+    consola.log(`
+${bold(magenta(name))} ${dim(`v${version}`)}`);
+    consola.log(dim("\n--------------\n"));
+    await migratePnpmSettings(options);
+    consola.success(green("pnpm settings migrate successfully!"));
+  } catch (err) {
+    consola.fail(red(String(err)));
+    if (err instanceof Error && err.stack) {
+      consola.fail(dim(err.stack?.split("\n").slice(1).join("\n")));
+    }
+    process.exit(1);
+  }
+});
+cli.parse();

package/dist/index.d.mts

@@ -0,0 +1,29 @@
+interface Options {
+    /**
+     * Whether to remove `.npmrc` file
+     *
+     * @default true
+     */
+    cleanNpmrc?: boolean;
+    /**
+     * Whether to remove `pnpm` field in `package.json`
+     *
+     * @default true
+     */
+    cleanPackageJson?: boolean;
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * Strategy to handle conflicts
+     */
+    strategy?: 'discard' | 'merge' | 'overwrite';
+}
+declare function resolveOptions(options?: Options): Required<Options>;
+
+declare function migratePnpmSettings(rawOptions?: Options): Promise<void>;
+
+export { type Options, migratePnpmSettings, resolveOptions };

package/dist/index.mjs

@@ -0,0 +1,8 @@
+export { m as migratePnpmSettings, r as resolveOptions } from './shared/pnpm-settings-migrator.BiiS7DGq.mjs';
+import '@ntnyq/utils';
+import 'pathe';
+import 'node:process';
+import 'node:fs/promises';
+import 'js-yaml';
+import 'camelcase-keys';
+import 'read-ini-file';

package/dist/shared/pnpm-settings-migrator.BiiS7DGq.mjs

@@ -0,0 +1,85 @@
+import { pick } from '@ntnyq/utils';
+import { resolve } from 'pathe';
+import process from 'node:process';
+import { access, readFile, writeFile } from 'node:fs/promises';
+import { load, dump } from 'js-yaml';
+import camelcaseKeys from 'camelcase-keys';
+import { readIniFile } from 'read-ini-file';
+
+const NPMRC = ".npmrc";
+const PACKAGE_JSON = "package.json";
+const PNPM_WORKSPACE_YAML = "pnpm-workspace.yaml";
+const PNPM_SETTINGS_FIELDS = [
+  "allowedDeprecatedVersions",
+  "allowNonAppliedPatches",
+  "auditConfig",
+  "configDependencies",
+  "executionEnv",
+  "ignoredBuiltDependencies",
+  "ignoredOptionalDependencies",
+  "neverBuiltDependencies",
+  "onlyBuiltDependencies",
+  "onlyBuiltDependenciesFile",
+  "overrides",
+  "packageExtensions",
+  "patchedDependencies",
+  "peerDependencyRules",
+  "requiredScripts",
+  "supportedArchitectures",
+  "updateConfig"
+];
+
+function resolveOptions(options = {}) {
+  return {
+    cleanNpmrc: options.cleanNpmrc ?? true,
+    cleanPackageJson: options.cleanPackageJson ?? true,
+    cwd: options.cwd ?? process.cwd(),
+    strategy: options.strategy ?? "merge"
+  };
+}
+
+async function fsExists(path) {
+  return access(path).then(() => true).catch(() => false);
+}
+async function fsReadFile(path) {
+  return await readFile(path, "utf-8");
+}
+async function fsWriteFile(path, content) {
+  await writeFile(path, content, "utf-8");
+}
+
+async function readNpmrc(path) {
+  const content = await readIniFile(path);
+  return camelcaseKeys(content);
+}
+
+async function readPackageJson(path) {
+  const content = await fsReadFile(path);
+  return JSON.parse(content);
+}
+
+async function readPnpmWorkspace(path) {
+  const content = await fsReadFile(path);
+  return load(content);
+}
+async function writePnpmWorkspace(path, pnpmWorkspace) {
+  await fsWriteFile(path, dump(pnpmWorkspace));
+}
+
+async function migratePnpmSettings(rawOptions = {}) {
+  const options = resolveOptions(rawOptions);
+  const npmrcPath = resolve(options.cwd, NPMRC);
+  const packageJsonPath = resolve(options.cwd, PACKAGE_JSON);
+  const pnpmWorkspaceYamlPath = resolve(options.cwd, PNPM_WORKSPACE_YAML);
+  const isNpmrcExist = await fsExists(npmrcPath);
+  const isPackageJsonExist = await fsExists(packageJsonPath);
+  const isPnpmWorkspaceExist = await fsExists(pnpmWorkspaceYamlPath);
+  const pnpmWorkspaceContent = {
+    ...isNpmrcExist ? pick(await readNpmrc(npmrcPath), PNPM_SETTINGS_FIELDS) : {},
+    ...isPackageJsonExist ? (await readPackageJson(packageJsonPath)).pnpm : {},
+    ...isPnpmWorkspaceExist ? await readPnpmWorkspace(pnpmWorkspaceYamlPath) : {}
+  };
+  await writePnpmWorkspace(pnpmWorkspaceYamlPath, pnpmWorkspaceContent);
+}
+
+export { migratePnpmSettings as m, resolveOptions as r };

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "pnpm-settings-migrator",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Move pnpm settings from `pnpm` field in `package.json` and `.npmrc` file to `pnpm-workspace.yaml`",
+  "keywords": [
+    "migrator",
+    "pnpm",
+    "settings"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "ntnyq",
+    "email": "ntnyq13@gmail.com"
+  },
+  "homepage": "https://github.com/ntnyq/pnpm-settings-migrator#readme",
+  "repository": "ntnyq/pnpm-settings-migrator",
+  "bugs": {
+    "url": "https://github.com/ntnyq/pnpm-settings-migrator/issues"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "bin": "./bin.mjs",
+  "files": [
+    "bin.mjs",
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@ntnyq/utils": "^0.6.1",
+    "@pnpm/types": "^1000.2.1",
+    "cac": "^6.7.14",
+    "camelcase-keys": "^9.1.3",
+    "consola": "^3.4.0",
+    "js-yaml": "^4.1.0",
+    "pathe": "^2.0.3",
+    "read-ini-file": "^4.0.0"
+  },
+  "devDependencies": {
+    "@ntnyq/eslint-config": "^4.0.0-beta.11",
+    "@ntnyq/prettier-config": "^2.0.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.13.9",
+    "bumpp": "^10.0.3",
+    "eslint": "^9.21.0",
+    "husky": "^9.1.7",
+    "nano-staged": "^0.8.0",
+    "npm-run-all2": "^7.0.2",
+    "prettier": "^3.5.3",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "unbuild": "^3.5.0",
+    "vitest": "^3.0.8"
+  },
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "nano-staged": {
+    "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix",
+    "*.{css,scss,html}": "prettier -uw"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --watch",
+    "lint": "eslint",
+    "release": "run-s release:check release:version release:publish",
+    "release:check": "run-s lint typecheck test",
+    "release:publish": "pnpm publish",
+    "release:version": "bumpp",
+    "start": "tsx src/cli.ts",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}