fix(pkg): output like npm view does, do not force json output

BREAKING CHANGE: The `npm pkg` output is no longer forced to json.  This means you can get single values without having to worry about wrapping of the values.  It also outputs non-json content more similarly to `npm view`.

Fixes npm/statusboard#1080

Author: wraithgar

lib/commands/pkg.js

@@ -1,3 +1,4 @@
+const { inspect } = require('node:util')
 const { output } = require('proc-log')
 const PackageJson = require('@npmcli/package-json')
 const BaseCommand = require('../base-cmd.js')
@@ -56,25 +57,40 @@ class Pkg extends BaseCommand {
   }
 
   async get (args, { path, workspace }) {
-    this.npm.config.set('json', true)
     const pkgJson = await PackageJson.load(path)
+    const json = this.npm.config.get('json')
 
-    let result = pkgJson.content
+    // filter out the newline/indent symbols from the package-json object
+    let result = JSON.parse(JSON.stringify(pkgJson.content))
 
     if (args.length) {
-      result = new Queryable(result).query(args)
-      // in case there's only a single argument and a single result from the query just prints that one element to stdout.
-      // TODO(BREAKING_CHANGE): much like other places where we unwrap single item arrays this should go away.
-      // it makes the behavior unknown for users who don't already know the shape of the data.
-      if (Object.keys(result).length === 1 && args.length === 1) {
-        result = result[args]
+      result = new Queryable(result).query(args, { unwrapSingleItemArrays: false })
+      if (args.length === 1 && !json) {
+        if (workspace) {
+          return output.standard(`${workspace} ${result[args[0]]}`)
+        }
+        return output.standard(result[args[0]])
       }
     }
 
-    // The display layer is responsible for calling JSON.stringify on the result
-    // TODO: https://github.com/npm/cli/issues/5508 a raw mode has been requested similar to jq -r.
-    // If that was added then this method should no longer set `json:true` all the time
-    output.buffer(workspace ? { [workspace]: result } : result)
+    if (json) {
+      output.buffer(workspace ? { [workspace]: result } : result)
+    } else {
+      for (let [f, d] of Object.entries(result)) {
+        d = inspect(d, {
+          showHidden: false,
+          depth: 5,
+          colors: this.npm.color,
+          maxArrayLength: null,
+        })
+
+        if (workspace) {
+          output.standard(`${workspace} ${f} = ${d}`)
+        } else {
+          output.standard(`${f} = ${d}`)
+        }
+      }
+    }
   }
 
   async set (args, { path }) {

lib/commands/view.js

@@ -204,6 +204,7 @@ class View extends BaseCommand {
     const includeVersions = versions.length > 1
 
     let includeFields
+    // TODO if we ask for two fields but only one existed we treat it as if we only asked for one field, this needs to be fixed
     const res = versions.flatMap((v) => {
       const fields = Object.entries(data[v])
 

tap-snapshots/test/lib/commands/pkg.js.test.cjs

@@ -5,13 +5,13 @@
  * Make sure to inspect the output below.  Do not ignore changes!
  */
 'use strict'
-exports[`test/lib/commands/pkg.js TAP delete multiple field > should delete multiple fields from package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP delete delete multiple field > should delete multiple fields from package.json 1`] = `
 Object {
   "name": "foo",
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP delete nested field > should delete nested fields from package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP delete delete nested field > should delete nested fields from package.json 1`] = `
 Object {
   "info": Object {
     "foo": Object {
@@ -25,7 +25,7 @@ Object {
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP delete single field > should delete single field from package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP delete delete single field > should delete single field from package.json 1`] = `
 Object {
   "name": "foo",
 }
@@ -39,59 +39,58 @@ Object {
 `
 
 exports[`test/lib/commands/pkg.js TAP get array field > should print retrieved array field 1`] = `
-[
-  "index.js",
-  "cli.js"
-]
+[ 'index.js', 'cli.js' ]
 `
 
 exports[`test/lib/commands/pkg.js TAP get array item > should print retrieved array field 1`] = `
-
+index.js
 `
 
-exports[`test/lib/commands/pkg.js TAP get array nested items notation > should print json result containing matching results 1`] = `
+exports[`test/lib/commands/pkg.js TAP get json no args > should print package.json content 1`] = `
 {
-  "contributors[0].name": "Ruy",
-  "contributors[1].name": "Gar"
+  "name": "foo",
+  "version": "1.1.1"
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP get multiple arg > should print retrieved package.json fields 1`] = `
+exports[`test/lib/commands/pkg.js TAP get json with args > should print package.json content 1`] = `
 {
-  "name": "foo",
-  "version": "1.1.1"
+  "name": "foo"
 }
 `
 
+exports[`test/lib/commands/pkg.js TAP get multiple arg > should print retrieved package.json fields 1`] = `
+name = 'foo'
+version = '1.1.1'
+`
+
 exports[`test/lib/commands/pkg.js TAP get multiple arg with empty value > should print retrieved package.json field regardless of empty value 1`] = `
-{
-  "name": "foo",
-  "author": ""
-}
+name = 'foo'
+author = ''
 `
 
 exports[`test/lib/commands/pkg.js TAP get multiple arg with only one arg existing > should print retrieved package.json field 1`] = `
-{
-  "name": "foo"
-}
+name = 'foo'
 `
 
 exports[`test/lib/commands/pkg.js TAP get nested arg > node test.js 1`] = `
-"node test.js"
+node test.js
 `
 
 exports[`test/lib/commands/pkg.js TAP get no args > should print package.json content 1`] = `
-{
-  "name": "foo",
-  "version": "1.1.1"
-}
+name = 'foo'
+version = '1.1.1'
+`
+
+exports[`test/lib/commands/pkg.js TAP get non string > should print retrieved package.json field 1`] = `
+{ '@npmcli/test': '*' }
 `
 
 exports[`test/lib/commands/pkg.js TAP get single arg > should print retrieved package.json field 1`] = `
-"1.1.1"
+1.1.1
 `
 
-exports[`test/lib/commands/pkg.js TAP push to array syntax > should append to arrays using empty bracket syntax 1`] = `
+exports[`test/lib/commands/pkg.js TAP set push to array syntax > should append to arrays using empty bracket syntax 1`] = `
 Object {
   "keywords": Array [
     "foo",
@@ -103,7 +102,7 @@ Object {
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP set --json > should add fields to package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP set set --json > should add fields to package.json 1`] = `
 Object {
   "description": "awesome",
   "foo": Object {
@@ -123,7 +122,7 @@ Object {
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP set = separate value > should add single field to package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP set set = separate value > should add single field to package.json 1`] = `
 Object {
   "name": "foo",
   "tap": Object {
@@ -135,7 +134,7 @@ Object {
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP set multiple fields > should add single field to package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP set set multiple fields > should add single field to package.json 1`] = `
 Object {
   "bin": Object {
     "foo": "foo.js",
@@ -148,7 +147,7 @@ Object {
 }
 `
 
-exports[`test/lib/commands/pkg.js TAP set single field > should add single field to package.json 1`] = `
+exports[`test/lib/commands/pkg.js TAP set set single field > should add single field to package.json 1`] = `
 Object {
   "description": "Awesome stuff",
   "name": "foo",
@@ -157,21 +156,22 @@ Object {
 `
 
 exports[`test/lib/commands/pkg.js TAP single workspace multiple args > should only return info for one workspace 1`] = `
-{
-  "a": {
-    "name": "a",
-    "version": "1.0.0"
-  }
-}
+a name = 'a'
+a version = '1.0.0'
 `
 
 exports[`test/lib/commands/pkg.js TAP single workspace single arg > should only return info for one workspace 1`] = `
-{
-  "a": "1.0.0"
-}
+a 1.0.0
 `
 
 exports[`test/lib/commands/pkg.js TAP workspaces get > should return expected result for configured workspaces 1`] = `
+a name = 'a'
+a version = '1.0.0'
+b name = 'b'
+b version = '1.2.3'
+`
+
+exports[`test/lib/commands/pkg.js TAP workspaces get json > should return expected json result for configured workspaces 1`] = `
 {
   "a": {
     "name": "a",