@illumine/npm-diff 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,25 @@
+# @illumine/npm-diff
+
+Diff two versions of an npm package in VS Code, unminified and formatted.
+
+## CLI
+
+```sh
+npx @illumine/npm-diff react 18.2.0 18.3.0
+```
+
+Omit the versions to pick them interactively. Opens VS Code with the
+[compare-folders](https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders)
+extension, so a `code` CLI on your `PATH` is required.
+
+## Options
+
+| Option            | Description                          | Default                       |
+| ----------------- | -------------------------------------| ----------------------------- |
+| `-r, --registry`  | npm registry to query.               | `https://registry.npmjs.org`  |
+| `-w, --workspace` | Directory to place the two versions. | a temp dir, removed on exit   |
+| `-u, --unminify`  | Unminify sources before diffing.     | off                           |
+
+## License
+
+MIT

package/lib/index.cjs

@@ -69,7 +69,7 @@ async function formatTree(dir) {
     try {
       const { code: formatted } = await oxfmt.format(path.basename(file), code, {
         tabWidth: 2,
-        printWidth: 120
+        printWidth: 100
       });
       await promises.writeFile(file, formatted);
     } catch {
@@ -105,32 +105,39 @@ async function launchDiff(left, right) {
 
 // src/npm-diff.ts
 var NpmDiff = class {
-  constructor(pkg, registry = DEFAULT_REGISTRY) {
+  constructor(pkg, options = {}) {
     this.pkg = pkg;
-    this.registry = registry;
+    this.registry = options.registry ?? DEFAULT_REGISTRY;
+    this.workdir = options.workspace ? path.resolve(options.workspace) : zx.tmpdir("npmdiff-");
+    this.clean = options.workspace === void 0;
+    this.unminify = options.unminify ?? false;
   }
   pkg;
-  registry;
   packument;
-  workdir = zx.tmpdir("npmdiff-");
+  registry;
+  workdir;
+  clean;
+  unminify;
   async run(specA, specB) {
     await ensureVscode();
     this.packument = await zx.spinner(
       `Fetching '${this.pkg}' from npm\u2026`,
       () => fetchPackument(this.pkg, this.registry)
     );
-    const [left, right] = specA && specB ? sortVersions(this.resolve(specA), this.resolve(specB)) : await this.pickVersions(specA);
-    if (left === right) {
-      throw new CliError(`Both specs resolve to ${left} \u2014 there is nothing to diff.`);
+    const [versionA, versionB] = specA && specB ? sortVersions(this.resolve(specA), this.resolve(specB)) : await this.pickVersions(specA);
+    if (versionA === versionB) {
+      throw new CliError(`Both specs resolve to ${versionA} \u2014 there is nothing to diff.`);
     }
     try {
-      await this.prepare(left);
-      await this.prepare(right);
-      console.log(zx.chalk.green(`Opening VS Code to diff ${this.pkg} ${left} \u2194 ${right}`));
-      await launchDiff(path.join(this.workdir, left), path.join(this.workdir, right));
-      console.log(zx.chalk.dim("VS Code closed \u2014 cleaning up temporary files."));
+      const left = await this.prepare(versionA);
+      const right = await this.prepare(versionB);
+      console.log(zx.chalk.green(`Opening VS Code to diff ${this.pkg} ${versionA} \u2194 ${versionB}`));
+      await launchDiff(left, right);
+      console.log(
+        this.clean ? zx.chalk.dim("VS Code closed \u2014 cleaning up temporary files.") : zx.chalk.dim(`VS Code closed \u2014 files kept in ${this.workdir}`)
+      );
     } finally {
-      await zx.fs.remove(this.workdir);
+      if (this.clean) await zx.fs.remove(this.workdir);
     }
   }
   /** Resolve a version or dist-tag into a concrete published version. */
@@ -161,8 +168,9 @@ var NpmDiff = class {
     await zx.fs.mkdirp(dir);
     const tarball = await zx.spinner(`Downloading ${label}`, () => this.download(version, dir));
     await zx.spinner(`Unpacking ${label}`, () => this.unpack(tarball, dir));
-    await zx.spinner(`Unminifying ${label}`, () => unminifyTree(dir));
+    if (this.unminify) await zx.spinner(`Unminifying ${label}`, () => unminifyTree(dir));
     await zx.spinner(`Formatting ${label}`, () => formatTree(dir));
+    return dir;
   }
   async download(version, dir) {
     const { stdout } = await zx.$`npm pack ${this.pkg}@${version} --registry ${this.registry} --pack-destination ${dir} --json`;
@@ -178,9 +186,10 @@ var NpmDiff = class {
 // src/index.ts
 zx.$.verbose = false;
 var program = new extraTypings.Command();
-program.name("npmdiff").description("Diff two versions of an npm package in VS Code, unminified and formatted").argument("<pkgname>", "npm package name (scoped names supported)").argument("[spec-a]", "a version or dist-tag").argument("[spec-b]", "a version or dist-tag").option("--registry <url>", "npm registry to query", DEFAULT_REGISTRY).action(
-  (pkgname, specA, specB, options) => new NpmDiff(pkgname, options.registry).run(specA, specB)
-);
+program.name("npmdiff").description("Diff two versions of an npm package in VS Code, unminified and formatted").argument("<pkgname>", "npm package name (scoped names supported)").argument("[spec-a]", "a version or dist-tag").argument("[spec-b]", "a version or dist-tag").option("-r, --registry <url>", "npm registry to query", DEFAULT_REGISTRY).option(
+  "-w, --workspace <dir>",
+  "directory to place the two versions; kept instead of auto-cleaned when set"
+).option("-u, --unminify", "unminify sources before diffing", false).action((pkgname, specA, specB, options) => new NpmDiff(pkgname, options).run(specA, specB));
 program.parseAsync().catch((error) => {
   if (error instanceof CliError) {
     console.error(zx.chalk.red(error.message));

package/lib/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { Command } from '@commander-js/extra-typings';
 import { $, chalk, tmpdir, spinner, fs, which, glob } from 'zx';
-import { join, basename } from 'path';
+import { resolve, join, basename } from 'path';
 import semver from 'semver';
 import { extract } from 'tar';
 import { confirm, search } from '@inquirer/prompts';
@@ -63,7 +63,7 @@ async function formatTree(dir) {
     try {
       const { code: formatted } = await format(basename(file), code, {
         tabWidth: 2,
-        printWidth: 120
+        printWidth: 100
       });
       await writeFile(file, formatted);
     } catch {
@@ -99,32 +99,39 @@ async function launchDiff(left, right) {
 
 // src/npm-diff.ts
 var NpmDiff = class {
-  constructor(pkg, registry = DEFAULT_REGISTRY) {
+  constructor(pkg, options = {}) {
     this.pkg = pkg;
-    this.registry = registry;
+    this.registry = options.registry ?? DEFAULT_REGISTRY;
+    this.workdir = options.workspace ? resolve(options.workspace) : tmpdir("npmdiff-");
+    this.clean = options.workspace === void 0;
+    this.unminify = options.unminify ?? false;
   }
   pkg;
-  registry;
   packument;
-  workdir = tmpdir("npmdiff-");
+  registry;
+  workdir;
+  clean;
+  unminify;
   async run(specA, specB) {
     await ensureVscode();
     this.packument = await spinner(
       `Fetching '${this.pkg}' from npm\u2026`,
       () => fetchPackument(this.pkg, this.registry)
     );
-    const [left, right] = specA && specB ? sortVersions(this.resolve(specA), this.resolve(specB)) : await this.pickVersions(specA);
-    if (left === right) {
-      throw new CliError(`Both specs resolve to ${left} \u2014 there is nothing to diff.`);
+    const [versionA, versionB] = specA && specB ? sortVersions(this.resolve(specA), this.resolve(specB)) : await this.pickVersions(specA);
+    if (versionA === versionB) {
+      throw new CliError(`Both specs resolve to ${versionA} \u2014 there is nothing to diff.`);
     }
     try {
-      await this.prepare(left);
-      await this.prepare(right);
-      console.log(chalk.green(`Opening VS Code to diff ${this.pkg} ${left} \u2194 ${right}`));
-      await launchDiff(join(this.workdir, left), join(this.workdir, right));
-      console.log(chalk.dim("VS Code closed \u2014 cleaning up temporary files."));
+      const left = await this.prepare(versionA);
+      const right = await this.prepare(versionB);
+      console.log(chalk.green(`Opening VS Code to diff ${this.pkg} ${versionA} \u2194 ${versionB}`));
+      await launchDiff(left, right);
+      console.log(
+        this.clean ? chalk.dim("VS Code closed \u2014 cleaning up temporary files.") : chalk.dim(`VS Code closed \u2014 files kept in ${this.workdir}`)
+      );
     } finally {
-      await fs.remove(this.workdir);
+      if (this.clean) await fs.remove(this.workdir);
     }
   }
   /** Resolve a version or dist-tag into a concrete published version. */
@@ -155,8 +162,9 @@ var NpmDiff = class {
     await fs.mkdirp(dir);
     const tarball = await spinner(`Downloading ${label}`, () => this.download(version, dir));
     await spinner(`Unpacking ${label}`, () => this.unpack(tarball, dir));
-    await spinner(`Unminifying ${label}`, () => unminifyTree(dir));
+    if (this.unminify) await spinner(`Unminifying ${label}`, () => unminifyTree(dir));
     await spinner(`Formatting ${label}`, () => formatTree(dir));
+    return dir;
   }
   async download(version, dir) {
     const { stdout } = await $`npm pack ${this.pkg}@${version} --registry ${this.registry} --pack-destination ${dir} --json`;
@@ -172,9 +180,10 @@ var NpmDiff = class {
 // src/index.ts
 $.verbose = false;
 var program = new Command();
-program.name("npmdiff").description("Diff two versions of an npm package in VS Code, unminified and formatted").argument("<pkgname>", "npm package name (scoped names supported)").argument("[spec-a]", "a version or dist-tag").argument("[spec-b]", "a version or dist-tag").option("--registry <url>", "npm registry to query", DEFAULT_REGISTRY).action(
-  (pkgname, specA, specB, options) => new NpmDiff(pkgname, options.registry).run(specA, specB)
-);
+program.name("npmdiff").description("Diff two versions of an npm package in VS Code, unminified and formatted").argument("<pkgname>", "npm package name (scoped names supported)").argument("[spec-a]", "a version or dist-tag").argument("[spec-b]", "a version or dist-tag").option("-r, --registry <url>", "npm registry to query", DEFAULT_REGISTRY).option(
+  "-w, --workspace <dir>",
+  "directory to place the two versions; kept instead of auto-cleaned when set"
+).option("-u, --unminify", "unminify sources before diffing", false).action((pkgname, specA, specB, options) => new NpmDiff(pkgname, options).run(specA, specB));
 program.parseAsync().catch((error) => {
   if (error instanceof CliError) {
     console.error(chalk.red(error.message));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@illumine/npm-diff",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Diff two versions of an npm package in VS Code, unminified and formatted",
   "type": "module",
   "bin": {