Support json format output with `outdated` command #5582

Shinyaigeek · 2022-11-03T16:35:24Z

Summary

Support json format output with outdated command

Ticket

Closes: #2705

Details

support JSON format output with outdated command if --format json is specified.

Test

I tested this with my own project,

pnpm outdated --format json

{
        "@types/yargs": {
                "current": "17.0.11",
                "latest": "17,0.13",
                "dependencyKind": "dev"
        },
        "dotenv": {
                "current": "16.0.1",
                "latest": "16,0.3",
                "dependencyKind": "dev"
        },
        "jsdom": {
                "current": "20.0.0",
                "latest": "20,0.2",
                "dependencyKind": "dev"
        },
        "tslib": {
                "current": "2.4.0",
                "latest": "2,4.1"
        }
}

Shinyaigeek · 2022-11-03T16:40:04Z

packages/plugin-commands-outdated/src/outdated.ts

    table: Boolean,
+    format: ['json'],


If we support this feature, it may be better to merge table and format options. such as format: ['json', 'table', 'list']

adding this, I also think this would be good to support markdown table format with outdated command. I would like to use outdated command's output with GitHub's issue, and it will be helpful to support markdown table format

If we support this feature, it may be better to merge table and format options. such as format: ['json', 'table', 'list']

sounds good. Regarding markdown, I am not sure how frequently that would be needed.

I added the process to handle table and list format option in 5d82338. Should we deprecate table option in outdated command?

As for the markdown table format, the only use case I can come up with is copying and pasting the output into a GitHub issue. I feel it is good to support this, but should we support this? (Of course this will be implemented in the other PR if we will do)

zkochan · 2022-11-03T21:48:12Z

Sounds good

Shinyaigeek · 2022-11-04T17:50:48Z

packages/plugin-commands-outdated/src/outdated.ts

+function renderOutdatedJSON (outdatedPackages: readonly OutdatedPackage[], opts: { long?: boolean }) {
+  const outdatedPackagesJSON = {} as {


I wondered whether I should create a function that is almost equivalent to renderLatest, only without the output with chalk, but I was concerned that the implementation would be scattered, so I implemented it by adding withoutChalk argument which disables chalk output

Shinyaigeek · 2022-11-04T17:51:23Z

@zkochan first implementation is done!, so please review this when you are free 🙇

zkochan · 2022-11-05T00:21:41Z

packages/plugin-commands-outdated/src/outdated.ts

@@ -289,26 +326,32 @@ export function renderCurrent ({ current, wanted }: OutdatedPackage) {
  return `${output} (wanted ${wanted})`
 }

-export function renderLatest (outdatedPkg: OutdatedWithVersionDiff): string {
+export function renderLatest (outdatedPkg: OutdatedWithVersionDiff, withoutChalk = false): string {


I don't see any benefit from using this function. Just create a new one.

I was concerned about a scattering of implementation, but this is not a firm intention, so fixed in 90069a4 👍

zkochan · 2022-11-05T00:23:07Z

packages/plugin-commands-outdated/src/outdated.ts

  if (latestManifest == null) return ''
  const outputs = []
  if (latestManifest.deprecated) {
-    outputs.push(wrapAnsi(chalk.redBright(latestManifest.deprecated), 40))
+    const detail = latestManifest.deprecated
+    outputs.push(wrapAnsi(withoutChalk ? detail : chalk.redBright(detail), 40))


why do you need to wrap for the json output?

Sorry, just mistake. 90069a4 👍

zkochan · 2022-11-05T00:23:21Z

packages/plugin-commands-outdated/src/outdated.ts

  return colorizeSemverDiff({ change, diff })
 }

-export function renderDetails ({ latestManifest }: OutdatedPackage) {
+export function renderDetails ({ latestManifest }: OutdatedPackage, withoutChalk = false) {


create a new function for json

same here #5582 (comment)

zkochan · 2022-11-05T00:38:29Z

packages/plugin-commands-outdated/src/outdated.ts

+    [outdatedPackageName: string]: {
+      current: string
+      latest: string
+      dependencyKind?: 'dev' | 'optional'


why is belongsTo not good?

if you want to keep it, rename it to dependencyType and probably make it required.

https://github.com/pnpm/pnpm/blob/main/packages/plugin-commands-outdated/src/outdated.ts#L278 I was going to fit to renderPackageName, but this is not a firm intention. fixed in 5abaceb

zkochan · 2022-11-05T00:39:20Z

packages/plugin-commands-outdated/src/recursive.ts

@@ -153,6 +157,39 @@ ${renderCurrent(outdatedPkg)} ${chalk.grey('=>')} ${renderLatest(outdatedPkg)}`
    .join('\n\n') + '\n'
 }

+function renderOutdatedJSON (outdatedMap: Record<string, OutdatedInWorkspace>, opts: { long?: boolean }) {


why isn't the similar function from outdated.ts reused here?

I was wondering which or not I should re-implement renderOutdatedJSON also in recursive.ts or not. I decided to re-implement it because

in recursive, dependentPackages field is added and this requires OutdatedInWorkspace (but this is trivial)

sortOutdatedPackages function, which is used in both of outdated and recursive, is a bit different in outdated and recursive…

zkochan · 2022-11-05T00:40:20Z

packages/plugin-commands-outdated/test/index.ts

+\t\t"latest": "3.1.0",
+\t\t"dependencyKind": "dev"
+\t}
+}`)


it looks pretty ugly. You could just run JSON.stringify to generate the expected output.

good idea! Thank you! 2f3f4f5 👍

zkochan · 2022-11-05T00:41:02Z

packages/plugin-commands-outdated/test/index.ts

+    const { output, exitCode } = await outdated.handler({
+      ...OUTDATED_OPTIONS,
+      dir: process.cwd(),
+      long: true,
+      table: false,
+    })
+
+    expect(exitCode).toBe(1)
+    expect(stripAnsi(output)).toBe(`@pnpm.e2e/deprecated
+1.0.0 => Deprecated
+This package is deprecated. Lorem ipsum
+dolor sit amet, consectetur adipiscing
+elit.
+https://foo.bar/qar
+
+is-negative
+1.0.0 => 2.1.0
+https://github.com/kevva/is-negative#readme
+
+is-positive (dev)
+1.0.0 => 3.1.0
+https://github.com/kevva/is-positive#readme
+`)


why is this needed? This format already existed before your changes. Why do you add a test for it?

Sorry, just mistake. c92fd62 👍

zkochan · 2022-11-05T14:21:05Z

packages/plugin-commands-outdated/src/outdated.ts

    table: Boolean,
+    format: ['json'],


If we support this feature, it may be better to merge table and format options. such as format: ['json', 'table', 'list']

sounds good. Regarding markdown, I am not sure how frequently that would be needed.

zkochan · 2022-11-05T14:28:12Z

packages/plugin-commands-outdated/src/outdated.ts

+  for (const outdatedPkg of sortOutdatedPackages(outdatedPackages)) {
+    const { packageName, belongsTo } = outdatedPkg
+    outdatedPackagesJSON[packageName] = {
+      current: renderCurrent(outdatedPkg),


It is a JSON, so I would rather return the unprocessed fields as they are. Like:

Suggested change

current: renderCurrent(outdatedPkg),

current: outdatedPkg.current,

wanted: outdatedPkg.wanted,

Certainly!! This is about JSON format and this is usually used with automation process, so it is better to simplify. 2299772 👍

zkochan · 2022-11-05T14:31:52Z

packages/plugin-commands-outdated/src/outdated.ts

+    const { packageName, belongsTo } = outdatedPkg
+    outdatedPackagesJSON[packageName] = {
+      current: renderCurrent(outdatedPkg),
+      latest: extractLatest(outdatedPkg),


I don't think you need a function. Just return

Suggested change

latest: extractLatest(outdatedPkg),

latestVersion: outdatedPkg.latestManifest?.version,

latestDeprecated: outdatedPkg.latestManifest?.deprecated,

same as #5582 (comment)

I thought user want to know which package is deprecated, but they only know which package is deprecated by checking current field is equal to latestVersion field and this is not friendly. So I added deprecated field.

zkochan · 2022-11-05T14:33:33Z

packages/plugin-commands-outdated/src/outdated.ts

+    }
+
+    if (opts.long) {
+      outdatedPackagesJSON[packageName].details = extractDetails(outdatedPkg)


I think for long we can just pass the whole latest manifest

Suggested change

outdatedPackagesJSON[packageName].details = extractDetails(outdatedPkg)

outdatedPackagesJSON[packageName].latestManifest = outdatedPkg.latestManifest

same as #5582 (comment)

…son command

…son command with recursive

…--format json command

Shinyaigeek commented Nov 3, 2022

View reviewed changes

Shinyaigeek force-pushed the feature/support-format-option-for-outdated-command branch from 3951b2b to 4325363 Compare November 4, 2022 17:30

Shinyaigeek changed the title ~~[PoC] Support json format output with outdated command~~ Support json format output with outdated command Nov 4, 2022

Shinyaigeek force-pushed the feature/support-format-option-for-outdated-command branch from 4325363 to 70a69bb Compare November 4, 2022 17:46

Shinyaigeek self-assigned this Nov 4, 2022

Shinyaigeek added type: feature area: outdated labels Nov 4, 2022

Shinyaigeek commented Nov 4, 2022

View reviewed changes

Shinyaigeek marked this pull request as ready for review November 4, 2022 17:50

Shinyaigeek requested a review from zkochan as a code owner November 4, 2022 17:50

zkochan requested changes Nov 5, 2022

View reviewed changes

Shinyaigeek requested a review from zkochan November 5, 2022 09:02

zkochan reviewed Nov 5, 2022

View reviewed changes

Shinyaigeek requested a review from zkochan November 5, 2022 17:08

zkochan approved these changes Nov 6, 2022

View reviewed changes

Shinyaigeek and others added 13 commits November 6, 2022 03:13

feat(outdated): output outdated packages as JSON string with format=j…

e716406

…son command

feat(outdated): output outdated packages as JSON string with format=j…

b528665

…son command with recursive

chore(outdated): implement unit test for format=json option

617ce7b

chore(outdated): implement unit test for format=json option in recursive

2ff539b

chore: add changeset

7b06e14

refactor(outdated): split render modules

8791bb4

chore(outdated): remove unnecessary test

3d98e8f

refactor(outdated): write test code with JSON.stringify for outdated …

c828901

…--format json command

refactor(outdated): dependencyKind -> dependencyType

f742181

fix(outdated): simplify json output format

60a8ce0

feat(outdated): support table and list option on format option

349a9a9

refactor: outdated

070b5e6

refactor: outdated

d9847ed

zkochan added 4 commits November 6, 2022 03:13

refactor: outdated

f37afc7

refactor: outdated

b4f19bb

refactor: outdated

a755115

refactor: outdated

72b4d27

zkochan force-pushed the feature/support-format-option-for-outdated-command branch from e8bcde1 to 72b4d27 Compare November 6, 2022 01:14

zkochan merged commit 46852d4 into main Nov 6, 2022

zkochan deleted the feature/support-format-option-for-outdated-command branch November 6, 2022 01:37

zkochan added this to the v7.15 milestone Nov 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support json format output with `outdated` command #5582

Support json format output with `outdated` command #5582

Shinyaigeek commented Nov 3, 2022 •

edited

Shinyaigeek Nov 3, 2022

Shinyaigeek Nov 4, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan commented Nov 3, 2022

Shinyaigeek Nov 4, 2022

Shinyaigeek commented Nov 4, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

Shinyaigeek Nov 5, 2022

zkochan Nov 5, 2022

Shinyaigeek Nov 5, 2022

		function renderOutdatedJSON (outdatedPackages: readonly OutdatedPackage[], opts: { long?: boolean }) {
		const outdatedPackagesJSON = {} as {

	current: renderCurrent(outdatedPkg),
	current: outdatedPkg.current,
	wanted: outdatedPkg.wanted,

	latest: extractLatest(outdatedPkg),
	latestVersion: outdatedPkg.latestManifest?.version,
	latestDeprecated: outdatedPkg.latestManifest?.deprecated,

	outdatedPackagesJSON[packageName].details = extractDetails(outdatedPkg)
	outdatedPackagesJSON[packageName].latestManifest = outdatedPkg.latestManifest

Support json format output with outdated command #5582

Support json format output with outdated command #5582

Conversation

Shinyaigeek commented Nov 3, 2022 • edited

Summary

Ticket

Details

Test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zkochan commented Nov 3, 2022

Choose a reason for hiding this comment

Shinyaigeek commented Nov 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Support json format output with `outdated` command #5582

Support json format output with `outdated` command #5582

Shinyaigeek commented Nov 3, 2022 •

edited