feat(plugin-js-packages): add Yarn v2 outdated, improve naming

Author: Tlacenka

packages/plugin-js-packages/README.md

@@ -10,9 +10,12 @@ This plugin checks for known vulnerabilities and outdated dependencies.
 It supports the following package managers:
 
 - [NPM](https://docs.npmjs.com/)
-- [Yarn v1](https://classic.yarnpkg.com/docs/) & [Yarn v2+](https://yarnpkg.com/getting-started)
+- [Yarn v1](https://classic.yarnpkg.com/docs/)[Yarn v2+](https://yarnpkg.com/getting-started)
 - [PNPM](https://pnpm.io/pnpm-cli)
 
+> ![NOTE]
+> As of now, in order to check outdated dependencies for Yarn v2+, you need to install [`yarn-plugin-outdated`](https://github.com/mskelton/yarn-plugin-outdated).
+
 ## Getting started
 
 1. If you haven't already, install [@code-pushup/cli](../cli/README.md) and create a configuration file.

packages/plugin-js-packages/src/lib/runner/outdated/constants.ts

@@ -1,7 +1,11 @@
 import { IssueSeverity } from '@code-pushup/models';
 import { PackageManager } from '../../config';
 import { OutdatedResult, VersionType } from './types';
-import { npmToOutdatedResult, yarnv1ToOutdatedResult } from './unify-type';
+import {
+  npmToOutdatedResult,
+  yarnv1ToOutdatedResult,
+  yarnv2ToOutdatedResult,
+} from './unify-type';
 
 export const outdatedSeverity: Record<VersionType, IssueSeverity> = {
   major: 'error',
@@ -12,7 +16,7 @@ export const outdatedSeverity: Record<VersionType, IssueSeverity> = {
 export const outdatedArgs: Record<PackageManager, string[]> = {
   npm: ['--json', '--long'],
   'yarn-classic': ['--json'],
-  'yarn-modern': [],
+  'yarn-modern': ['--json'],
   pnpm: [],
 };
 
@@ -22,7 +26,6 @@ export const normalizeOutdatedMapper: Record<
 > = {
   npm: npmToOutdatedResult,
   'yarn-classic': yarnv1ToOutdatedResult,
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  'yarn-modern': _ => [],
+  'yarn-modern': yarnv2ToOutdatedResult,
   pnpm: _ => [],
 };

packages/plugin-js-packages/src/lib/runner/outdated/types.ts

@@ -1,4 +1,3 @@
-// Subset of NPM outdated JSON type
 export const versionType = ['major', 'minor', 'patch'] as const;
 export type VersionType = (typeof versionType)[number];
 export type PackageVersion = Record<VersionType, number>;
@@ -7,18 +6,28 @@ export type DependencyGroupLong =
   | 'devDependencies'
   | 'optionalDependencies';
 
-export type VersionOverview = {
+// Unified Outdated result type
+export type OutdatedResult = {
+  name: string;
+  current: string;
+  latest: string;
+  type: DependencyGroupLong;
+  url?: string;
+}[];
+
+// Subset of NPM outdated JSON type
+export type NpmVersionOverview = {
   current?: string;
   latest: string;
   type: DependencyGroupLong;
   homepage?: string;
 };
 
-export type NormalizedVersionOverview = Omit<VersionOverview, 'current'> & {
+export type NpmNormalizedOverview = Omit<NpmVersionOverview, 'current'> & {
   current: string;
 };
-export type NormalizedOutdatedEntries = [string, NormalizedVersionOverview][];
-export type NpmOutdatedResultJson = Record<string, VersionOverview>;
+
+export type NpmOutdatedResultJson = Record<string, NpmVersionOverview>;
 
 // Subset of Yarn v1 outdated JSON type
 export type Yarnv1VersionOverview = [
@@ -41,11 +50,12 @@ type Yarnv1Table = {
 
 export type Yarnv1OutdatedResultJson = [Yarnv1Info, Yarnv1Table];
 
-// Unified Outdated result type
-export type OutdatedResult = {
-  name: string;
+// Subset of Yarn v2 outdated JSON type
+export type Yarnv2VersionOverview = {
   current: string;
   latest: string;
+  name: string;
   type: DependencyGroupLong;
-  url?: string;
-}[];
+};
+
+export type Yarnv2OutdatedResultJson = Yarnv2VersionOverview[];

packages/plugin-js-packages/src/lib/runner/outdated/unify-type.ts

@@ -1,9 +1,10 @@
 import { fromJsonLines, objectToEntries } from '@code-pushup/utils';
 import {
-  NormalizedVersionOverview,
+  NpmNormalizedOverview,
   NpmOutdatedResultJson,
   OutdatedResult,
   Yarnv1OutdatedResultJson,
+  Yarnv2OutdatedResultJson,
 } from './types';
 
 export function npmToOutdatedResult(output: string): OutdatedResult {
@@ -12,7 +13,7 @@ export function npmToOutdatedResult(output: string): OutdatedResult {
   // https://stackoverflow.com/questions/42267101/npm-outdated-command-shows-missing-in-current-version
   return objectToEntries(npmOutdated)
     .filter(
-      (entry): entry is [string, NormalizedVersionOverview] =>
+      (entry): entry is [string, NpmNormalizedOverview] =>
         entry[1].current != null,
     )
     .map(([name, overview]) => ({
@@ -36,3 +37,14 @@ export function yarnv1ToOutdatedResult(output: string): OutdatedResult {
     url,
   }));
 }
+
+export function yarnv2ToOutdatedResult(output: string): OutdatedResult {
+  const npmOutdated = JSON.parse(output) as Yarnv2OutdatedResultJson;
+
+  return npmOutdated.map(({ name, current, latest, type }) => ({
+    name,
+    current,
+    latest,
+    type,
+  }));
+}

packages/plugin-js-packages/src/lib/runner/outdated/unify-type.unit.test.ts

@@ -1,9 +1,13 @@
 import { describe, expect, it } from 'vitest';
 import { toJsonLines } from '@code-pushup/utils';
-import { OutdatedResult } from './types';
-import { npmToOutdatedResult, yarnv1ToOutdatedResult } from './unify-type';
+import { OutdatedResult, Yarnv2OutdatedResultJson } from './types';
+import {
+  npmToOutdatedResult,
+  yarnv1ToOutdatedResult,
+  yarnv2ToOutdatedResult,
+} from './unify-type';
 
-describe('npmOutdatedToOutdatedResult', () => {
+describe('npmToOutdatedResult', () => {
   it('should transform NPM outdated to unified outdated result', () => {
     expect(
       npmToOutdatedResult(
@@ -59,7 +63,7 @@ describe('npmOutdatedToOutdatedResult', () => {
   });
 });
 
-describe('yarnv1OutdatedToOutdatedResult', () => {
+describe('yarnv1ToOutdatedResult', () => {
   const yarnInfo = { type: 'info', data: 'Colours' };
   it('should transform Yarn v1 outdated to unified outdated result', () => {
     const table = {
@@ -90,3 +94,30 @@ describe('yarnv1OutdatedToOutdatedResult', () => {
     expect(yarnv1ToOutdatedResult(toJsonLines([yarnInfo, table]))).toEqual([]);
   });
 });
+
+describe('yarnv2ToOutdatedResult', () => {
+  it('should transform Yarn v2 outdated to unified outdated result', () => {
+    const outdated = [
+      {
+        name: 'nx',
+        current: '16.8.1',
+        latest: '17.0.0',
+        type: 'dependencies',
+      },
+      {
+        name: 'vite',
+        current: '4.3.1',
+        latest: '5.1.4',
+        type: 'devDependencies',
+      },
+    ] satisfies Yarnv2OutdatedResultJson;
+
+    expect(yarnv2ToOutdatedResult(JSON.stringify(outdated))).toStrictEqual(
+      outdated,
+    );
+  });
+
+  it('should transform no dependencies to empty array', () => {
+    expect(yarnv2ToOutdatedResult('[]')).toEqual([]);
+  });
+});