@code-pushup/js-packages-plugin 0.81.0 → 0.83.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/package.json +3 -3
  2. package/src/lib/config.js +21 -13
  3. package/src/lib/config.js.map +1 -1
  4. package/src/lib/utils.d.ts +1 -1
  5. package/src/lib/utils.js +2 -1
  6. package/src/lib/utils.js.map +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/js-packages-plugin",
3
- "version": "0.81.0",
3
+ "version": "0.83.0",
4
4
  "description": "Code PushUp plugin for JavaScript packages 🛡️",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-js-packages#readme",
@@ -37,8 +37,8 @@
37
37
  },
38
38
  "type": "module",
39
39
  "dependencies": {
40
- "@code-pushup/models": "0.81.0",
41
- "@code-pushup/utils": "0.81.0",
40
+ "@code-pushup/models": "0.83.0",
41
+ "@code-pushup/utils": "0.83.0",
42
42
  "build-md": "^0.4.1",
43
43
  "semver": "^7.6.0",
44
44
  "yargs": "^17.7.2",
package/src/lib/config.js CHANGED
@@ -3,17 +3,19 @@ import { issueSeveritySchema, pluginScoreTargetsSchema, } from '@code-pushup/mod
3
3
  import { defaultAuditLevelMapping } from './constants.js';
4
4
  export const dependencyGroups = ['prod', 'dev', 'optional'];
5
5
  const dependencyGroupSchema = z.enum(dependencyGroups);
6
- const packageCommandSchema = z.enum(['audit', 'outdated']);
7
- const packageManagerIdSchema = z.enum([
8
- 'npm',
9
- 'yarn-classic',
10
- 'yarn-modern',
11
- 'pnpm',
12
- ]);
6
+ const packageCommandSchema = z.enum(['audit', 'outdated']).meta({
7
+ title: 'PackageCommand',
8
+ });
9
+ const packageManagerIdSchema = z
10
+ .enum(['npm', 'yarn-classic', 'yarn-modern', 'pnpm'])
11
+ .meta({ title: 'PackageManagerId' });
13
12
  const packageJsonPathSchema = z
14
13
  .string()
15
14
  .regex(/package\.json$/, 'File path must end with package.json')
16
- .describe('File path to package.json, tries to use root package.json at CWD by default')
15
+ .meta({
16
+ title: 'PackageJsonPath',
17
+ description: 'File path to package.json, tries to use root package.json at CWD by default',
18
+ })
17
19
  .default('package.json');
18
20
  export const packageAuditLevels = [
19
21
  'critical',
@@ -22,7 +24,9 @@ export const packageAuditLevels = [
22
24
  'low',
23
25
  'info',
24
26
  ];
25
- const packageAuditLevelSchema = z.enum(packageAuditLevels);
27
+ const packageAuditLevelSchema = z.enum(packageAuditLevels).meta({
28
+ title: 'PackageAuditLevel',
29
+ });
26
30
  export function fillAuditLevelMapping(mapping) {
27
31
  return {
28
32
  critical: mapping.critical ?? defaultAuditLevelMapping.critical,
@@ -32,14 +36,17 @@ export function fillAuditLevelMapping(mapping) {
32
36
  info: mapping.info ?? defaultAuditLevelMapping.info,
33
37
  };
34
38
  }
35
- export const jsPackagesPluginConfigSchema = z.object({
39
+ export const jsPackagesPluginConfigSchema = z
40
+ .object({
36
41
  checks: z
37
42
  .array(packageCommandSchema)
38
43
  .min(1)
39
44
  .default(['audit', 'outdated'])
40
- .describe('Package manager commands to be run. Defaults to both audit and outdated.'),
45
+ .meta({
46
+ description: 'Package manager commands to be run. Defaults to both audit and outdated.',
47
+ }),
41
48
  packageManager: packageManagerIdSchema
42
- .describe('Package manager to be used.')
49
+ .meta({ description: 'Package manager to be used.' })
43
50
  .optional(),
44
51
  dependencyGroups: z
45
52
  .array(dependencyGroupSchema)
@@ -52,5 +59,6 @@ export const jsPackagesPluginConfigSchema = z.object({
52
59
  .describe('Mapping of audit levels to issue severity. Custom mapping or overrides may be entered manually, otherwise has a default preset.'),
53
60
  packageJsonPath: packageJsonPathSchema,
54
61
  scoreTargets: pluginScoreTargetsSchema,
55
- });
62
+ })
63
+ .meta({ title: 'JSPackagesPluginConfig' });
56
64
  //# sourceMappingURL=config.js.map
package/src/lib/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,CAAU,CAAC;AACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAGvD,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AAG3D,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC;IACpC,KAAK;IACL,cAAc;IACd,aAAa;IACb,MAAM;CACP,CAAC,CAAC;AAGH,MAAM,qBAAqB,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,KAAK,CAAC,gBAAgB,EAAE,sCAAsC,CAAC;KAC/D,QAAQ,CACP,6EAA6E,CAC9E;KACA,OAAO,CAAC,cAAc,CAAC,CAAC;AAI3B,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU;IACV,MAAM;IACN,UAAU;IACV,KAAK;IACL,MAAM;CACE,CAAC;AACX,MAAM,uBAAuB,GAAG,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAK3D,MAAM,UAAU,qBAAqB,CACnC,OAA+B;IAE/B,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB,CAAC,QAAQ;QAC/D,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,wBAAwB,CAAC,IAAI;QACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB,CAAC,QAAQ;QAC/D,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,wBAAwB,CAAC,GAAG;QAChD,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,wBAAwB,CAAC,IAAI;KACpD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,oBAAoB,CAAC;SAC3B,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC9B,QAAQ,CACP,0EAA0E,CAC3E;IACH,cAAc,EAAE,sBAAsB;SACnC,QAAQ,CAAC,6BAA6B,CAAC;SACvC,QAAQ,EAAE;IACb,gBAAgB,EAAE,CAAC;SAChB,KAAK,CAAC,qBAAqB,CAAC;SAC5B,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3B,iBAAiB,EAAE,CAAC;SACjB,aAAa,CAAC,uBAAuB,EAAE,mBAAmB,CAAC;SAC3D,OAAO,CAAC,wBAAwB,CAAC;SACjC,SAAS,CAAC,qBAAqB,CAAC;SAChC,QAAQ,CACP,iIAAiI,CAClI;IACH,eAAe,EAAE,qBAAqB;IACtC,YAAY,EAAE,wBAAwB;CACvC,CAAC,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,CAAU,CAAC;AACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAGvD,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,KAAK,EAAE,gBAAgB;CACxB,CAAC,CAAC;AAGH,MAAM,sBAAsB,GAAG,CAAC;KAC7B,IAAI,CAAC,CAAC,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;KACpD,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC,CAAC;AAGvC,MAAM,qBAAqB,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,KAAK,CAAC,gBAAgB,EAAE,sCAAsC,CAAC;KAC/D,IAAI,CAAC;IACJ,KAAK,EAAE,iBAAiB;IACxB,WAAW,EACT,6EAA6E;CAChF,CAAC;KACD,OAAO,CAAC,cAAc,CAAC,CAAC;AAI3B,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU;IACV,MAAM;IACN,UAAU;IACV,KAAK;IACL,MAAM;CACE,CAAC;AACX,MAAM,uBAAuB,GAAG,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC;IAC9D,KAAK,EAAE,mBAAmB;CAC3B,CAAC,CAAC;AAKH,MAAM,UAAU,qBAAqB,CACnC,OAA+B;IAE/B,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB,CAAC,QAAQ;QAC/D,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,wBAAwB,CAAC,IAAI;QACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB,CAAC,QAAQ;QAC/D,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,wBAAwB,CAAC,GAAG;QAChD,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,wBAAwB,CAAC,IAAI;KACpD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACN,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,oBAAoB,CAAC;SAC3B,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC9B,IAAI,CAAC;QACJ,WAAW,EACT,0EAA0E;KAC7E,CAAC;IACJ,cAAc,EAAE,sBAAsB;SACnC,IAAI,CAAC,EAAE,WAAW,EAAE,6BAA6B,EAAE,CAAC;SACpD,QAAQ,EAAE;IACb,gBAAgB,EAAE,CAAC;SAChB,KAAK,CAAC,qBAAqB,CAAC;SAC5B,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3B,iBAAiB,EAAE,CAAC;SACjB,aAAa,CAAC,uBAAuB,EAAE,mBAAmB,CAAC;SAC3D,OAAO,CAAC,wBAAwB,CAAC;SACjC,SAAS,CAAC,qBAAqB,CAAC;SAChC,QAAQ,CACP,iIAAiI,CAClI;IACH,eAAe,EAAE,qBAAqB;IACtC,YAAY,EAAE,wBAAwB;CACvC,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,wBAAwB,EAAE,CAAC,CAAC"}
package/src/lib/utils.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { type JSPackagesPluginConfig } from './config.js';
2
- export declare function normalizeConfig(config?: JSPackagesPluginConfig): Promise<{
2
+ export declare function normalizeConfig(config: JSPackagesPluginConfig | undefined): Promise<{
3
3
  packageManager: import("./package-managers/types.js").PackageManager;
4
4
  checks: ("audit" | "outdated")[];
5
5
  depGroups: ("prod" | "dev" | "optional")[];
package/src/lib/utils.js CHANGED
@@ -1,8 +1,9 @@
1
+ import { validate } from '@code-pushup/models';
1
2
  import { jsPackagesPluginConfigSchema, } from './config.js';
2
3
  import { derivePackageManager } from './package-managers/derive-package-manager.js';
3
4
  import { packageManagers } from './package-managers/package-managers.js';
4
5
  export async function normalizeConfig(config) {
5
- const jsPackagesPluginConfig = jsPackagesPluginConfigSchema.parse(config ?? {});
6
+ const jsPackagesPluginConfig = validate(jsPackagesPluginConfigSchema, config ?? {});
6
7
  const { packageManager, dependencyGroups: dependencyGroupsCfg = [], checks: checksCfg = [], ...jsPackagesPluginConfigRest } = jsPackagesPluginConfig;
7
8
  const checks = [...new Set(checksCfg)];
8
9
  const depGroups = [...new Set(dependencyGroupsCfg)];
package/src/lib/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,4BAA4B,GAC7B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEzE,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAA+B;IACnE,MAAM,sBAAsB,GAAG,4BAA4B,CAAC,KAAK,CAC/D,MAAM,IAAI,EAAE,CACb,CAAC;IAEF,MAAM,EACJ,cAAc,EACd,gBAAgB,EAAE,mBAAmB,GAAG,EAAE,EAC1C,MAAM,EAAE,SAAS,GAAG,EAAE,EACtB,GAAG,0BAA0B,EAC9B,GAAG,sBAAsB,CAAC;IAC3B,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACpD,MAAM,EAAE,GAAG,eAAe,CAAC,cAAc,IAAI,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,CAAC;IAE7E,OAAO;QACL,GAAG,0BAA0B;QAC7B,cAAc,EAAE,EAAE;QAClB,MAAM;QACN,SAAS;KACV,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAEL,4BAA4B,GAC7B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEzE,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAA0C;IAE1C,MAAM,sBAAsB,GAAG,QAAQ,CACrC,4BAA4B,EAC5B,MAAM,IAAI,EAAE,CACb,CAAC;IAEF,MAAM,EACJ,cAAc,EACd,gBAAgB,EAAE,mBAAmB,GAAG,EAAE,EAC1C,MAAM,EAAE,SAAS,GAAG,EAAE,EACtB,GAAG,0BAA0B,EAC9B,GAAG,sBAAsB,CAAC;IAC3B,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACpD,MAAM,EAAE,GAAG,eAAe,CAAC,cAAc,IAAI,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,CAAC;IAE7E,OAAO;QACL,GAAG,0BAA0B;QAC7B,cAAc,EAAE,EAAE;QAClB,MAAM;QACN,SAAS;KACV,CAAC;AACJ,CAAC"}