feat: add pkg fix subcommand

npm · Jul 5, 2023 · 67459e7 · 67459e7
1 parent c61e037
commit 67459e7
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/docs/lib/content/commands/npm-pkg.md b/docs/lib/content/commands/npm-pkg.md
@@ -135,6 +135,13 @@ Returned values are always in **json** format.
     npm pkg delete scripts.build
     ```
 
+* `npm pkg fix`
+
+    Auto corrects common errors in your `package.json`.  npm already
+    does this during `publish`, which leads to subtle (mostly harmless)
+    differences between the contents of your `package.json` file and the
+    manifest that npm uses during installation.
+
 ### Workspaces support
 
 You can set/get/delete items across your configured workspaces by using the

diff --git a/lib/commands/pkg.js b/lib/commands/pkg.js
@@ -11,6 +11,7 @@ class Pkg extends BaseCommand {
     'delete <key> [<key> ...]',
     'set [<array>[<index>].<key>=<value> ...]',
     'set [<array>[].<key>=<value> ...]',
+    'fix',
   ]
 
   static params = [
@@ -45,6 +46,8 @@ class Pkg extends BaseCommand {
         return this.set(_args)
       case 'delete':
         return this.delete(_args)
+      case 'fix':
+        return this.fix(_args)
       default:
         throw this.usageError()
     }
@@ -136,6 +139,11 @@ class Pkg extends BaseCommand {
     pkgJson.update(q.toJSON())
     await pkgJson.save()
   }
+
+  async fix () {
+    const pkgJson = await PackageJson.fix(this.prefix)
+    await pkgJson.save()
+  }
 }
 
 module.exports = Pkg
diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
@@ -3660,6 +3660,7 @@ npm pkg get [<key> [<key> ...]]
 npm pkg delete <key> [<key> ...]
 npm pkg set [<array>[<index>].<key>=<value> ...]
 npm pkg set [<array>[].<key>=<value> ...]
+npm pkg fix
 
 Options:
 [-f|--force] [--json]
@@ -3674,6 +3675,7 @@ npm pkg get [<key> [<key> ...]]
 npm pkg delete <key> [<key> ...]
 npm pkg set [<array>[<index>].<key>=<value> ...]
 npm pkg set [<array>[].<key>=<value> ...]
+npm pkg fix
 \`\`\`
 
 #### \`force\`

diff --git a/test/lib/commands/pkg.js b/test/lib/commands/pkg.js
@@ -617,3 +617,21 @@ t.test('workspaces', async t => {
     'should delete version field from workspace b'
   )
 })
+
+t.test('fix', async t => {
+  const { pkg, readPackageJson } = await mockNpm(t, {
+    prefixDir: {
+      'package.json': JSON.stringify({
+        name: 'foo ',
+        version: 'v1.1.1',
+      }),
+    },
+  })
+
+  await pkg('fix')
+  t.strictSame(
+    readPackageJson(),
+    { name: 'foo', version: '1.1.1' },
+    'fixes package.json issues'
+  )
+})