--format dep

#166 (comment)

Author: raineorshine

README.md

@@ -262,7 +262,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
   </tr>
   <tr>
     <td><a href="#format">--format &lt;value&gt;</a></td>
-    <td>Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines, installedVersion. (default: [])</td>
+    <td>Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion. (default: [])</td>
   </tr>
   <tr>
     <td>-g, --global</td>
@@ -634,12 +634,13 @@ Usage:
 Modify the output formatting or show additional information. Specify one or more comma-delimited values.
 
 <table>
+  <tr><td>dep</td><td>Prints the dependency type (dev, peer, optional) of each package.</td></tr>
   <tr><td>group</td><td>Groups packages by major, minor, patch, and major version zero updates.</td></tr>
+  <tr><td>installedVersion</td><td>Prints the exact current version number instead of a range.</td></tr>
+  <tr><td>lines</td><td>Prints name@version on separate lines. Useful for piping to npm install.</td></tr>
   <tr><td>ownerChanged</td><td>Shows if the package owner has changed.</td></tr>
   <tr><td>repo</td><td>Infers and displays links to the package's source code repository. Requires packages to be installed.</td></tr>
   <tr><td>time</td><td>Shows the publish time of each upgrade.</td></tr>
-  <tr><td>lines</td><td>Prints name@version on separate lines. Useful for piping to npm install.</td></tr>
-  <tr><td>installedVersion</td><td>Prints the exact current version number instead of a range.</td></tr>
 </table>
 
 ## groupFunction

src/cli-options.ts

@@ -171,12 +171,13 @@ const extendedHelpFormat: ExtendedHelp = ({ markdown }) => {
     colAligns: ['right', 'left'],
     markdown,
     rows: [
+      ['dep', `Prints the dependency type (dev, peer, optional) of each package.`],
       ['group', `Groups packages by major, minor, patch, and major version zero updates.`],
+      ['installedVersion', 'Prints the exact current version number instead of a range.'],
+      ['lines', 'Prints name@version on separate lines. Useful for piping to npm install.'],
       ['ownerChanged', `Shows if the package owner has changed.`],
       ['repo', `Infers and displays links to the package's source code repository. Requires packages to be installed.`],
       ['time', 'Shows the publish time of each upgrade.'],
-      ['lines', 'Prints name@version on separate lines. Useful for piping to npm install.'],
-      ['installedVersion', 'Prints the exact current version number instead of a range.'],
     ],
   })
 
@@ -759,11 +760,11 @@ const cliOptions: CLIOption[] = [
     long: 'format',
     arg: 'value',
     description:
-      'Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines, installedVersion.',
+      'Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion.',
     parse: value => (typeof value === 'string' ? value.split(',') : value),
     default: [],
     type: 'readonly string[]',
-    choices: ['group', 'ownerChanged', 'repo', 'time', 'lines', 'installedVersion'],
+    choices: ['dep', 'group', 'ownerChanged', 'repo', 'time', 'lines', 'installedVersion'],
     help: extendedHelpFormat,
   },
   {

src/lib/logging.ts

@@ -2,6 +2,7 @@
  * Loggin functions.
  */
 import Table from 'cli-table3'
+import fs from 'fs/promises'
 import { IgnoredUpgradeDueToEnginesNode } from '../types/IgnoredUpgradeDueToEnginesNode'
 import { IgnoredUpgradeDueToPeerDeps } from '../types/IgnoredUpgradeDueToPeerDeps'
 import { Index } from '../types/IndexType'
@@ -164,6 +165,7 @@ export async function toDependencyTable({
   pkgFile?: string
   time?: Index<string>
 }) {
+  const pkg = format?.includes('dep') && pkgFile ? JSON.parse(await fs.readFile(pkgFile, 'utf-8')) : null
   const table = renderDependencyTable(
     await Promise.all(
       Object.keys(toDeps)
@@ -173,6 +175,14 @@ export async function toDependencyTable({
             (format?.includes('installedVersion')
               ? await getPackageVersion(dep, undefined, { pkgFile })
               : fromDeps[dep]) || ''
+          const depType =
+            dep in (pkg?.devDependencies ?? {})
+              ? 'dev'
+              : dep in (pkg?.peerDependencies ?? {})
+                ? 'peer'
+                : dep in (pkg?.optionalDependencies ?? {})
+                  ? 'optional'
+                  : ''
           const toRaw = toDeps[dep] || ''
           const to = getVersion(toRaw)
           const ownerChanged = ownersChangedDeps
@@ -185,7 +195,15 @@ export async function toDependencyTable({
           const toColorized = colorizeDiff(getVersion(from), to)
           const repoUrl = format?.includes('repo') ? (await getRepoUrl(dep, undefined, { pkgFile })) || '' : ''
           const publishTime = format?.includes('time') && time?.[dep] ? time[dep] : ''
-          return [dep, from, '→', toColorized, ownerChanged, ...[repoUrl, publishTime].filter(x => x)]
+          return [
+            dep,
+            ...(format?.includes('dep') ? [depType ? chalk.gray(depType) : ''] : []),
+            from,
+            '→',
+            toColorized,
+            ownerChanged,
+            ...[repoUrl, publishTime].filter(x => x),
+          ]
         }),
     ),
   )

src/types/RunOptions.json

@@ -302,7 +302,7 @@
       "description": "Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. Run \"ncu --help --filterVersion\" for details."
     },
     "format": {
-      "description": "Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines, installedVersion. Run \"ncu --help --format\" for details.",
+      "description": "Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion. Run \"ncu --help --format\" for details.",
       "items": {
         "type": "string"
       },

src/types/RunOptions.ts

@@ -89,7 +89,7 @@ export interface RunOptions {
   /** Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. Run "ncu --help --filterVersion" for details. */
   filterVersion?: string | RegExp | readonly (string | RegExp)[] | FilterFunction
 
-  /** Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines, installedVersion. Run "ncu --help --format" for details. */
+  /** Modify the output formatting or show additional information. Specify one or more comma-delimited values: dep, group, ownerChanged, repo, time, lines, installedVersion. Run "ncu --help --format" for details. */
   format?: readonly string[]
 
   /** Check global packages instead of in the current project. */

test/format.test.ts

@@ -29,6 +29,54 @@ chaiSetup()
 const bin = path.join(__dirname, '../build/cli.js')
 
 describe('format', () => {
+  it('--format dep', async () => {
+    const stub = stubVersions(
+      {
+        'ncu-test-v2': '2.0.0',
+        'ncu-test-tag': '2.0.0',
+        'ncu-test-peer-update': '2.0.0',
+        'ncu-test-return-version': '2.0.0',
+      },
+      { spawn: true },
+    )
+    const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'npm-check-updates-'))
+    const pkgFile = path.join(tempDir, 'package.json')
+    await fs.writeFile(
+      pkgFile,
+      JSON.stringify({
+        dependencies: {
+          'ncu-test-v2': '^1.0.0',
+        },
+        devDependencies: {
+          'ncu-test-tag': '^1.0.0',
+        },
+        peerDependencies: {
+          'ncu-test-peer-update': '^1.0.0',
+        },
+        optionalDependencies: {
+          'ncu-test-return-version': '^1.0.0',
+        },
+      }),
+      'utf-8',
+    )
+    try {
+      const { stdout } = await spawn(
+        'node',
+        // -u was added to avoid accidentally matching dev, peer, optional from "Run ncu --dep prod,dev,peer,optional --format dep -u to upgrade package.json"
+        [bin, '--dep', 'prod,dev,peer,optional', '--format', 'dep', '-u'],
+        {},
+        { cwd: tempDir },
+      )
+
+      stdout.should.include('dev')
+      stdout.should.include('peer')
+      stdout.should.include('optional')
+    } finally {
+      await fs.rm(tempDir, { recursive: true, force: true })
+      stub.restore()
+    }
+  })
+
   // do not stubVersions here, because we need to test if if time is parsed correctly from npm-registry-fetch
   it('--format time', async () => {
     const timestamp = '2020-04-27T21:48:11.660Z'