feat: add description field to output to licenses command output (#5836)

Add the `description`-field to the output of the `licenses list`-command so that for each package the description in the package manifest gets listed too
pnpm · Dec 25, 2022 · 1d3995f · 1d3995f
1 parent 339c0a7
commit 1d3995f
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 47 deletions.
diff --git a/.changeset/chilly-flies-bow.md b/.changeset/chilly-flies-bow.md
@@ -0,0 +1,7 @@
+---
+"pnpm": minor
+"@pnpm/license-scanner": patch
+"@pnpm/plugin-commands-licenses": patch
+---
+
+Add the 'description'-field to the licenses output [#5836](https://github.com/pnpm/pnpm/pull/5836).
diff --git a/reviewing/license-scanner/src/licenses.ts b/reviewing/license-scanner/src/licenses.ts
@@ -19,6 +19,7 @@ export interface LicensePackage {
   licenseContents?: string
   author?: string
   homepage?: string
+  description?: string
   repository?: string
   path?: string
 }
@@ -52,6 +53,7 @@ function getDependenciesFromLicenseNode (
         licenseContents: dependencyNode.licenseContents,
         author: dependencyNode.author as string,
         homepage: dependencyNode.homepage as string,
+        description: dependencyNode.description,
         repository: dependencyNode.repository as string,
         path: dependencyNode.dir,
       },

diff --git a/reviewing/license-scanner/src/lockfileToLicenseNodeTree.ts b/reviewing/license-scanner/src/lockfileToLicenseNodeTree.ts
@@ -17,6 +17,7 @@ export interface LicenseNode {
   dir: string
   author?: string
   homepage?: string
+  description?: string
   repository?: string
   integrity?: string
   requires?: Record<string, string>
@@ -90,6 +91,7 @@ export async function lockfileToLicenseNode (
       licenseContents: packageInfo.licenseContents,
       author: packageInfo.author,
       homepage: packageInfo.homepage,
+      description: packageInfo.description,
       repository: packageInfo.repository,
       dir: packageInfo.path as string,
     }

diff --git a/reviewing/license-scanner/test/licenses.spec.ts b/reviewing/license-scanner/test/licenses.spec.ts
@@ -76,6 +76,7 @@ describe('licences', () => {
     expect(licensePackages).toEqual([
       {
         belongsTo: 'dependencies',
+        description: 'Package Description',
         version: '1.0.0',
         name: 'bar',
         license: 'MIT',
@@ -87,6 +88,7 @@ describe('licences', () => {
       },
       {
         belongsTo: 'dependencies',
+        description: 'Package Description',
         version: '1.0.0',
         name: 'foo',
         license: 'Unknown',

diff --git a/reviewing/plugin-commands-licenses/src/outputRenderer.ts b/reviewing/plugin-commands-licenses/src/outputRenderer.ts
@@ -35,6 +35,9 @@ function renderDetails (licensePackage: LicensePackage) {
   if (licensePackage.author) {
     outputs.push(licensePackage.author)
   }
+  if (licensePackage.description) {
+    outputs.push(licensePackage.description)
+  }
   if (licensePackage.homepage) {
     outputs.push(chalk.underline(licensePackage.homepage))
   }
@@ -63,6 +66,7 @@ function renderLicensesJson (licensePackages: readonly LicensePackage[]) {
         licenseContents: licensePkg.licenseContents,
         author: licensePkg.author,
         homepage: licensePkg.homepage,
+        description: licensePkg.description,
       } as LicensePackageJson
     }),
   ].flat()

diff --git a/reviewing/plugin-commands-licenses/test/__snapshots__/index.ts.snap b/reviewing/plugin-commands-licenses/test/__snapshots__/index.ts.snap
diff --git a/reviewing/plugin-commands-licenses/test/index.ts b/reviewing/plugin-commands-licenses/test/index.ts
@@ -118,6 +118,7 @@ test('pnpm licenses: output as json', async () => {
     'license',
     'author',
     'homepage',
+    'description',
   ])
   expect(packagesWithMIT[0].name).toBe('is-positive')
 })