--format homepage (#1600)

Author: raineorshine

README.md

@@ -643,6 +643,7 @@ Modify the output formatting or show additional information. Specify one or more
 <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>homepage</td><td>Displays links to the package's homepage if specified in its package.json.</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>

src/cli-options.ts

@@ -190,6 +190,7 @@ const extendedHelpFormat: ExtendedHelp = ({ 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.`],
+      ['homepage', `Displays links to the package's homepage if specified in its package.json.`],
       ['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.`],
@@ -793,7 +794,7 @@ const cliOptions: CLIOption[] = [
     parse: value => (typeof value === 'string' ? value.split(',') : value),
     default: [],
     type: 'readonly string[]',
-    choices: ['dep', 'group', 'ownerChanged', 'repo', 'time', 'lines', 'installedVersion'],
+    choices: ['dep', 'group', 'homepage', 'ownerChanged', 'repo', 'time', 'lines', 'installedVersion'],
     help: extendedHelpFormat,
   },
   {

src/lib/logging.ts

@@ -11,6 +11,7 @@ import { VersionResult } from '../types/VersionResult'
 import { VersionSpec } from '../types/VersionSpec'
 import chalk from './chalk'
 import filterObject from './filterObject'
+import getPackageJson from './getPackageJson'
 import getPackageVersion from './getPackageVersion'
 import getRepoUrl from './getRepoUrl'
 import {
@@ -193,6 +194,9 @@ export async function toDependencyTable({
               : '*unknown*'
             : ''
           const toColorized = colorizeDiff(getVersion(from), to)
+          const homepageUrl = format?.includes('homepage')
+            ? (await getPackageJson(dep, { pkgFile }))?.homepage || ''
+            : ''
           const repoUrl = format?.includes('repo') ? (await getRepoUrl(dep, undefined, { pkgFile })) || '' : ''
           const publishTime = format?.includes('time') && time?.[dep] ? time[dep] : ''
           return [
@@ -202,7 +206,7 @@ export async function toDependencyTable({
             '→',
             toColorized,
             ownerChanged,
-            ...[repoUrl, publishTime].filter(x => x),
+            ...[homepageUrl, repoUrl, publishTime].filter(x => x),
           ]
         }),
     ),

src/types/PackageFile.ts

@@ -13,6 +13,7 @@ export interface PackageFile {
   // deno only
   imports?: Index<VersionSpec>
   engines?: Index<VersionSpec>
+  homepage?: string
   name?: string
   // https://nodejs.org/api/packages.html#packagemanager
   packageManager?: string

src/types/RunOptions.json

@@ -33,6 +33,9 @@
           "$ref": "#/definitions/Index<string>",
           "description": "A very generic object."
         },
+        "homepage": {
+          "type": "string"
+        },
         "imports": {
           "$ref": "#/definitions/Index<string>",
           "description": "A very generic object."

test/format.test.ts

@@ -93,6 +93,27 @@ describe('format', () => {
     }
   })
 
+  it('--format homepage', async () => {
+    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: {
+          'hosted-git-info': '^5.0.0',
+        },
+      }),
+      'utf-8',
+    )
+    try {
+      await spawn('npm', ['install'], {}, { cwd: tempDir })
+      const { stdout } = await spawn('node', [bin, '--format', 'homepage'], {}, { cwd: tempDir })
+      stdout.should.include('https://github.com/npm/hosted-git-info')
+    } finally {
+      await removeDir(tempDir)
+    }
+  })
+
   it('--format lines', async () => {
     const stub = stubVersions(
       {