@code-pushup/models 0.85.0 → 0.87.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.
- package/package.json +1 -1
- package/src/index.d.ts +2 -2
- package/src/index.js +2 -2
- package/src/index.js.map +1 -1
- package/src/lib/plugin-config.d.ts +10 -0
- package/src/lib/plugin-config.js +7 -1
- package/src/lib/plugin-config.js.map +1 -1
package/package.json
CHANGED
package/src/index.d.ts
CHANGED
|
@@ -11,12 +11,12 @@ export { groupRefSchema, groupSchema, type Group, type GroupMeta, type GroupRef,
|
|
|
11
11
|
export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration.js';
|
|
12
12
|
export { DEFAULT_PERSIST_CONFIG, DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, DEFAULT_PERSIST_SKIP_REPORT, } from './lib/implementation/constants.js';
|
|
13
13
|
export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
|
|
14
|
-
export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, scoreSchema, slugSchema, type MaterialIcon, } from './lib/implementation/schemas.js';
|
|
14
|
+
export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, positiveIntSchema, scoreSchema, slugSchema, type MaterialIcon, } from './lib/implementation/schemas.js';
|
|
15
15
|
export { exists } from './lib/implementation/utils.js';
|
|
16
16
|
export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
|
|
17
17
|
export { issueSchema, issueSeveritySchema, type Issue, type IssueSeverity, } from './lib/issue.js';
|
|
18
18
|
export { formatSchema, persistConfigSchema, type Format, type PersistConfig, } from './lib/persist-config.js';
|
|
19
|
-
export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, type PluginConfig, type PluginContext, type PluginMeta, type PluginScoreTargets, } from './lib/plugin-config.js';
|
|
19
|
+
export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, pluginUrlsSchema, type PluginConfig, type PluginContext, type PluginMeta, type PluginScoreTargets, type PluginUrls, } from './lib/plugin-config.js';
|
|
20
20
|
export { auditReportSchema, pluginReportSchema, reportSchema, type AuditReport, type PluginReport, type Report, } from './lib/report.js';
|
|
21
21
|
export { auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, type AuditDiff, type AuditResult, type CategoryDiff, type CategoryResult, type GroupDiff, type GroupResult, type ReportsDiff, } from './lib/reports-diff.js';
|
|
22
22
|
export { runnerArgsSchema, runnerConfigSchema, runnerFilesPathsSchema, runnerFunctionSchema, type RunnerArgs, type RunnerConfig, type RunnerFilesPaths, type RunnerFunction, } from './lib/runner-config.js';
|
package/src/index.js
CHANGED
|
@@ -11,12 +11,12 @@ export { groupRefSchema, groupSchema, } from './lib/group.js';
|
|
|
11
11
|
export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration.js';
|
|
12
12
|
export { DEFAULT_PERSIST_CONFIG, DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, DEFAULT_PERSIST_SKIP_REPORT, } from './lib/implementation/constants.js';
|
|
13
13
|
export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
|
|
14
|
-
export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, scoreSchema, slugSchema, } from './lib/implementation/schemas.js';
|
|
14
|
+
export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, positiveIntSchema, scoreSchema, slugSchema, } from './lib/implementation/schemas.js';
|
|
15
15
|
export { exists } from './lib/implementation/utils.js';
|
|
16
16
|
export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
|
|
17
17
|
export { issueSchema, issueSeveritySchema, } from './lib/issue.js';
|
|
18
18
|
export { formatSchema, persistConfigSchema, } from './lib/persist-config.js';
|
|
19
|
-
export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, } from './lib/plugin-config.js';
|
|
19
|
+
export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, pluginUrlsSchema, } from './lib/plugin-config.js';
|
|
20
20
|
export { auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report.js';
|
|
21
21
|
export { auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff.js';
|
|
22
22
|
export { runnerArgsSchema, runnerConfigSchema, runnerFilesPathsSchema, runnerFunctionSchema, } from './lib/runner-config.js';
|
package/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,UAAU,GAEX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,aAAa,GACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,UAAU,GAEX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,aAAa,GACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,GAMjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAQlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,GAKrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,GAOX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC"}
|
|
@@ -2325,6 +2325,16 @@ export declare const pluginConfigSchema: z.ZodObject<{
|
|
|
2325
2325
|
* @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginconfig}
|
|
2326
2326
|
*/
|
|
2327
2327
|
export type PluginConfig = z.infer<typeof pluginConfigSchema>;
|
|
2328
|
+
export declare const pluginUrlsSchema: z.ZodUnion<readonly [z.ZodURL, z.ZodArray<z.ZodURL>, z.ZodRecord<z.ZodURL, z.ZodNumber>]>;
|
|
2329
|
+
/**
|
|
2330
|
+
* Type Definition: `PluginUrls`
|
|
2331
|
+
*
|
|
2332
|
+
* This type is derived from a Zod schema and represents
|
|
2333
|
+
* the validated structure of `PluginUrls` used within the application.
|
|
2334
|
+
*
|
|
2335
|
+
* @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginurls}
|
|
2336
|
+
*/
|
|
2337
|
+
export type PluginUrls = z.infer<typeof pluginUrlsSchema>;
|
|
2328
2338
|
export declare function findMissingSlugsInGroupRefs<T extends {
|
|
2329
2339
|
audits: Audit[];
|
|
2330
2340
|
groups?: Group[];
|
package/src/lib/plugin-config.js
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
import { pluginAuditsSchema } from './audit.js';
|
|
3
3
|
import { groupsSchema } from './group.js';
|
|
4
4
|
import { createCheck } from './implementation/checks.js';
|
|
5
|
-
import { materialIconSchema, metaSchema, packageVersionSchema, scoreTargetSchema, slugSchema, } from './implementation/schemas.js';
|
|
5
|
+
import { materialIconSchema, metaSchema, packageVersionSchema, scoreTargetSchema, slugSchema, weightSchema, } from './implementation/schemas.js';
|
|
6
6
|
import { formatSlugsList, hasMissingStrings } from './implementation/utils.js';
|
|
7
7
|
import { runnerConfigSchema, runnerFunctionSchema } from './runner-config.js';
|
|
8
8
|
export const pluginContextSchema = z
|
|
@@ -49,6 +49,12 @@ export const pluginConfigSchema = pluginMetaSchema
|
|
|
49
49
|
.extend(pluginDataSchema.shape)
|
|
50
50
|
.check(createCheck(findMissingSlugsInGroupRefs))
|
|
51
51
|
.meta({ title: 'PluginConfig' });
|
|
52
|
+
export const pluginUrlsSchema = z
|
|
53
|
+
.union([z.url(), z.array(z.url()), z.record(z.url(), weightSchema)])
|
|
54
|
+
.meta({
|
|
55
|
+
title: 'PluginUrls',
|
|
56
|
+
description: 'URL(s) to analyze. Single URL, array of URLs, or record of URLs with custom weights',
|
|
57
|
+
});
|
|
52
58
|
// every listed group ref points to an audit within the plugin
|
|
53
59
|
export function findMissingSlugsInGroupRefs({ audits, groups = [] }) {
|
|
54
60
|
const missingSlugs = getAuditSlugsFromGroups(audits, groups);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAc,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,YAAY,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,UAAU,
|
|
1
|
+
{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAc,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,YAAY,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,UAAU,EACV,YAAY,GACb,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,0CAA0C;CACxD,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC,KAAK,CACT;KACA,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;QACpB,WAAW,EAAE,uCAAuC;KACrD,CAAC;IACF,IAAI,EAAE,kBAAkB;CACzB,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAIjC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC;IACL,iBAAiB;IACjB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC;CACtD,CAAC;KACD,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EACT,kHAAkH;CACrH,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC3D,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,YAAY;IACpB,YAAY,EAAE,wBAAwB;IACtC,OAAO,EAAE,mBAAmB;CAC7B,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAEjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;KAC9B,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;KAC/C,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;AAInC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC;KACnE,IAAI,CAAC;IACJ,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,qFAAqF;CACxF,CAAC,CAAC;AAIL,8DAA8D;AAC9D,MAAM,UAAU,2BAA2B,CAEzC,EAAE,MAAM,EAAE,MAAM,GAAG,EAAE,EAAK;IAC1B,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,CACL,YAAY,IAAI;QACd,OAAO,EAAE,6DAA6D,eAAe,CACnF,YAAY,CACb,EAAE;KACJ,CACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAe,EAAE,MAAe;IAC/D,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAC1D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC"}
|