@redocly/recheck 0.1.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/README.md +544 -0
- package/dist/assertions/bullet-style.d.ts +3 -0
- package/dist/assertions/bullet-style.d.ts.map +1 -0
- package/dist/assertions/bullet-style.js +60 -0
- package/dist/assertions/bullet-style.js.map +1 -0
- package/dist/assertions/index.d.ts +21 -0
- package/dist/assertions/index.d.ts.map +1 -0
- package/dist/assertions/index.js +30 -0
- package/dist/assertions/index.js.map +1 -0
- package/dist/assertions/max-image-size.d.ts +3 -0
- package/dist/assertions/max-image-size.d.ts.map +1 -0
- package/dist/assertions/max-image-size.js +73 -0
- package/dist/assertions/max-image-size.js.map +1 -0
- package/dist/assertions/max-line-length.d.ts +3 -0
- package/dist/assertions/max-line-length.d.ts.map +1 -0
- package/dist/assertions/max-line-length.js +68 -0
- package/dist/assertions/max-line-length.js.map +1 -0
- package/dist/assertions/no-broken-fragment-links.d.ts +3 -0
- package/dist/assertions/no-broken-fragment-links.d.ts.map +1 -0
- package/dist/assertions/no-broken-fragment-links.js +79 -0
- package/dist/assertions/no-broken-fragment-links.js.map +1 -0
- package/dist/assertions/no-duplicate-headings.d.ts +3 -0
- package/dist/assertions/no-duplicate-headings.d.ts.map +1 -0
- package/dist/assertions/no-duplicate-headings.js +66 -0
- package/dist/assertions/no-duplicate-headings.js.map +1 -0
- package/dist/assertions/no-hard-tabs.d.ts +3 -0
- package/dist/assertions/no-hard-tabs.d.ts.map +1 -0
- package/dist/assertions/no-hard-tabs.js +63 -0
- package/dist/assertions/no-hard-tabs.js.map +1 -0
- package/dist/assertions/no-trailing-spaces.d.ts +3 -0
- package/dist/assertions/no-trailing-spaces.d.ts.map +1 -0
- package/dist/assertions/no-trailing-spaces.js +72 -0
- package/dist/assertions/no-trailing-spaces.js.map +1 -0
- package/dist/assertions/pattern.d.ts +3 -0
- package/dist/assertions/pattern.d.ts.map +1 -0
- package/dist/assertions/pattern.js +39 -0
- package/dist/assertions/pattern.js.map +1 -0
- package/dist/assertions/semantic-line-breaks.d.ts +3 -0
- package/dist/assertions/semantic-line-breaks.d.ts.map +1 -0
- package/dist/assertions/semantic-line-breaks.js +152 -0
- package/dist/assertions/semantic-line-breaks.js.map +1 -0
- package/dist/assertions/swap.d.ts +3 -0
- package/dist/assertions/swap.d.ts.map +1 -0
- package/dist/assertions/swap.js +39 -0
- package/dist/assertions/swap.js.map +1 -0
- package/dist/assertions/utils.d.ts +8 -0
- package/dist/assertions/utils.d.ts.map +1 -0
- package/dist/assertions/utils.js +57 -0
- package/dist/assertions/utils.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +125 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/run.d.ts +20 -0
- package/dist/commands/run.d.ts.map +1 -0
- package/dist/commands/run.js +115 -0
- package/dist/commands/run.js.map +1 -0
- package/dist/commands/validate.d.ts +8 -0
- package/dist/commands/validate.d.ts.map +1 -0
- package/dist/commands/validate.js +43 -0
- package/dist/commands/validate.js.map +1 -0
- package/dist/config/load.d.ts +20 -0
- package/dist/config/load.d.ts.map +1 -0
- package/dist/config/load.js +85 -0
- package/dist/config/load.js.map +1 -0
- package/dist/config/schema.d.ts +109 -0
- package/dist/config/schema.d.ts.map +1 -0
- package/dist/config/schema.js +103 -0
- package/dist/config/schema.js.map +1 -0
- package/dist/config/validate.d.ts +10 -0
- package/dist/config/validate.d.ts.map +1 -0
- package/dist/config/validate.js +129 -0
- package/dist/config/validate.js.map +1 -0
- package/dist/core/auto-fix.d.ts +16 -0
- package/dist/core/auto-fix.d.ts.map +1 -0
- package/dist/core/auto-fix.js +82 -0
- package/dist/core/auto-fix.js.map +1 -0
- package/dist/core/files.d.ts +6 -0
- package/dist/core/files.d.ts.map +1 -0
- package/dist/core/files.js +75 -0
- package/dist/core/files.js.map +1 -0
- package/dist/core/rule-filters.d.ts +28 -0
- package/dist/core/rule-filters.d.ts.map +1 -0
- package/dist/core/rule-filters.js +54 -0
- package/dist/core/rule-filters.js.map +1 -0
- package/dist/core/runner.d.ts +4 -0
- package/dist/core/runner.d.ts.map +1 -0
- package/dist/core/runner.js +135 -0
- package/dist/core/runner.js.map +1 -0
- package/dist/core/scope-parser.d.ts +26 -0
- package/dist/core/scope-parser.d.ts.map +1 -0
- package/dist/core/scope-parser.js +110 -0
- package/dist/core/scope-parser.js.map +1 -0
- package/dist/core/timing.d.ts +24 -0
- package/dist/core/timing.d.ts.map +1 -0
- package/dist/core/timing.js +39 -0
- package/dist/core/timing.js.map +1 -0
- package/dist/files.d.ts +2 -0
- package/dist/files.d.ts.map +1 -0
- package/dist/files.js +39 -0
- package/dist/files.js.map +1 -0
- package/dist/load-config.d.ts +25 -0
- package/dist/load-config.d.ts.map +1 -0
- package/dist/load-config.js +104 -0
- package/dist/load-config.js.map +1 -0
- package/dist/load.d.ts +25 -0
- package/dist/load.d.ts.map +1 -0
- package/dist/load.js +112 -0
- package/dist/load.js.map +1 -0
- package/dist/reporter/fixes.d.ts +3 -0
- package/dist/reporter/fixes.d.ts.map +1 -0
- package/dist/reporter/fixes.js +20 -0
- package/dist/reporter/fixes.js.map +1 -0
- package/dist/reporter/formats/github-actions.d.ts +6 -0
- package/dist/reporter/formats/github-actions.d.ts.map +1 -0
- package/dist/reporter/formats/github-actions.js +20 -0
- package/dist/reporter/formats/github-actions.js.map +1 -0
- package/dist/reporter/formats/json.d.ts +6 -0
- package/dist/reporter/formats/json.d.ts.map +1 -0
- package/dist/reporter/formats/json.js +24 -0
- package/dist/reporter/formats/json.js.map +1 -0
- package/dist/reporter/formats/sarif.d.ts +10 -0
- package/dist/reporter/formats/sarif.d.ts.map +1 -0
- package/dist/reporter/formats/sarif.js +66 -0
- package/dist/reporter/formats/sarif.js.map +1 -0
- package/dist/reporter/formats/table.d.ts +6 -0
- package/dist/reporter/formats/table.d.ts.map +1 -0
- package/dist/reporter/formats/table.js +38 -0
- package/dist/reporter/formats/table.js.map +1 -0
- package/dist/reporter/index.d.ts +10 -0
- package/dist/reporter/index.d.ts.map +1 -0
- package/dist/reporter/index.js +42 -0
- package/dist/reporter/index.js.map +1 -0
- package/dist/reporter/prioritize-problems.d.ts +7 -0
- package/dist/reporter/prioritize-problems.d.ts.map +1 -0
- package/dist/reporter/prioritize-problems.js +29 -0
- package/dist/reporter/prioritize-problems.js.map +1 -0
- package/dist/reporter/statistics.d.ts +17 -0
- package/dist/reporter/statistics.d.ts.map +1 -0
- package/dist/reporter/statistics.js +52 -0
- package/dist/reporter/statistics.js.map +1 -0
- package/dist/reporter/summary.d.ts +10 -0
- package/dist/reporter/summary.d.ts.map +1 -0
- package/dist/reporter/summary.js +48 -0
- package/dist/reporter/summary.js.map +1 -0
- package/dist/scope.d.ts +26 -0
- package/dist/scope.d.ts.map +1 -0
- package/dist/scope.js +110 -0
- package/dist/scope.js.map +1 -0
- package/dist/types/assertions.d.ts +56 -0
- package/dist/types/assertions.d.ts.map +1 -0
- package/dist/types/assertions.js +2 -0
- package/dist/types/assertions.js.map +1 -0
- package/dist/types/index.d.ts +6 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +6 -0
- package/dist/types/index.js.map +1 -0
- package/dist/types/problems.d.ts +21 -0
- package/dist/types/problems.d.ts.map +1 -0
- package/dist/types/problems.js +2 -0
- package/dist/types/problems.js.map +1 -0
- package/dist/types/reporting.d.ts +23 -0
- package/dist/types/reporting.d.ts.map +1 -0
- package/dist/types/reporting.js +2 -0
- package/dist/types/reporting.js.map +1 -0
- package/dist/types/rules.d.ts +43 -0
- package/dist/types/rules.d.ts.map +1 -0
- package/dist/types/rules.js +2 -0
- package/dist/types/rules.js.map +1 -0
- package/dist/types/validation.d.ts +6 -0
- package/dist/types/validation.d.ts.map +1 -0
- package/dist/types/validation.js +2 -0
- package/dist/types/validation.js.map +1 -0
- package/dist/types.d.ts +109 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/dist/validate.d.ts +31 -0
- package/dist/validate.d.ts.map +1 -0
- package/dist/validate.js +154 -0
- package/dist/validate.js.map +1 -0
- package/package.json +43 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAC7D,MAAM,MAAM,SAAS,GACjB,KAAK,GACL,SAAS,GACT,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,MAAM,EAAE,CAAC;AAEb,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAGD,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAGD,MAAM,MAAM,eAAe,GACvB,aAAa,GACb,gBAAgB,GAChB,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,2BAA2B,GAC3B,mBAAmB,GACnB,4BAA4B,CAAC;AAEjC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;CACb"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { RecheckConfig, NormalizedRule, ValidationError } from './types.js';
|
|
2
|
+
export declare class ConfigValidator {
|
|
3
|
+
private ajv;
|
|
4
|
+
private schema;
|
|
5
|
+
private constructor();
|
|
6
|
+
static create(): Promise<ConfigValidator>;
|
|
7
|
+
/**
|
|
8
|
+
* Validates configuration structure using JSON Schema
|
|
9
|
+
*/
|
|
10
|
+
validateStructure(config: any): ValidationError[];
|
|
11
|
+
/**
|
|
12
|
+
* Performs semantic validation and normalization
|
|
13
|
+
*/
|
|
14
|
+
validateSemantics(config: RecheckConfig): {
|
|
15
|
+
errors: ValidationError[];
|
|
16
|
+
rules: NormalizedRule[];
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Validates assertions in a rule
|
|
20
|
+
*/
|
|
21
|
+
private validateAssertions;
|
|
22
|
+
/**
|
|
23
|
+
* Full validation pipeline
|
|
24
|
+
*/
|
|
25
|
+
validate(config: any): {
|
|
26
|
+
isValid: boolean;
|
|
27
|
+
errors: ValidationError[];
|
|
28
|
+
rules: NormalizedRule[];
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=validate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAY,MAAM,YAAY,CAAC;AAE3F,qBAAa,eAAe;IAC1B,OAAO,CAAC,GAAG,CAAM;IACjB,OAAO,CAAC,MAAM,CAAY;IAE1B,OAAO;WAWM,MAAM,IAAI,OAAO,CAAC,eAAe,CAAC;IAM/C;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,eAAe,EAAE;IAmBjD;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,aAAa,GAAG;QACxC,MAAM,EAAE,eAAe,EAAE,CAAC;QAC1B,KAAK,EAAE,cAAc,EAAE,CAAC;KACzB;IAyCD;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA0C1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG;QACrB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,eAAe,EAAE,CAAC;QAC1B,KAAK,EAAE,cAAc,EAAE,CAAC;KACzB;CAoBF"}
|
package/dist/validate.js
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
import Ajv from 'ajv';
|
|
2
|
+
import addFormats from 'ajv-formats';
|
|
3
|
+
import * as fs from 'fs/promises';
|
|
4
|
+
export class ConfigValidator {
|
|
5
|
+
constructor(schema) {
|
|
6
|
+
Object.defineProperty(this, "ajv", {
|
|
7
|
+
enumerable: true,
|
|
8
|
+
configurable: true,
|
|
9
|
+
writable: true,
|
|
10
|
+
value: void 0
|
|
11
|
+
});
|
|
12
|
+
Object.defineProperty(this, "schema", {
|
|
13
|
+
enumerable: true,
|
|
14
|
+
configurable: true,
|
|
15
|
+
writable: true,
|
|
16
|
+
value: void 0
|
|
17
|
+
});
|
|
18
|
+
this.ajv = new Ajv({
|
|
19
|
+
useDefaults: true,
|
|
20
|
+
allErrors: true,
|
|
21
|
+
verbose: true,
|
|
22
|
+
});
|
|
23
|
+
addFormats(this.ajv);
|
|
24
|
+
this.schema = schema;
|
|
25
|
+
this.ajv.addSchema(this.schema, 'recheck-config');
|
|
26
|
+
}
|
|
27
|
+
static async create() {
|
|
28
|
+
const schemaPath = new URL('../schemas/recheck.schema.json', import.meta.url);
|
|
29
|
+
const schema = JSON.parse(await fs.readFile(schemaPath, 'utf8'));
|
|
30
|
+
return new ConfigValidator(schema);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Validates configuration structure using JSON Schema
|
|
34
|
+
*/
|
|
35
|
+
validateStructure(config) {
|
|
36
|
+
const validate = this.ajv.getSchema('recheck-config');
|
|
37
|
+
if (!validate) {
|
|
38
|
+
throw new Error('Schema not loaded');
|
|
39
|
+
}
|
|
40
|
+
const valid = validate(config);
|
|
41
|
+
if (!valid && validate.errors) {
|
|
42
|
+
return validate.errors.map((error) => ({
|
|
43
|
+
message: `${error.instancePath || '/'}: ${error.message}`,
|
|
44
|
+
path: error.instancePath,
|
|
45
|
+
value: error.data,
|
|
46
|
+
}));
|
|
47
|
+
}
|
|
48
|
+
return [];
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Performs semantic validation and normalization
|
|
52
|
+
*/
|
|
53
|
+
validateSemantics(config) {
|
|
54
|
+
const errors = [];
|
|
55
|
+
const rules = [];
|
|
56
|
+
for (const [key, rule] of Object.entries(config)) {
|
|
57
|
+
try {
|
|
58
|
+
// Derive name and shortName
|
|
59
|
+
const name = key;
|
|
60
|
+
const shortName = key.replace(/^recheck\//, '');
|
|
61
|
+
// Validate message placeholder count
|
|
62
|
+
const placeholderCount = (rule.message.match(/%s/g) || []).length;
|
|
63
|
+
if (placeholderCount > 2) {
|
|
64
|
+
errors.push({
|
|
65
|
+
message: `Rule "${name}": message can have at most 2 %s placeholders, found ${placeholderCount}`,
|
|
66
|
+
path: `${name}.message`,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
// Assertions validation
|
|
70
|
+
this.validateAssertions(rule, name, errors);
|
|
71
|
+
// Create normalized rule
|
|
72
|
+
const normalizedRule = {
|
|
73
|
+
...rule,
|
|
74
|
+
name,
|
|
75
|
+
shortName,
|
|
76
|
+
};
|
|
77
|
+
rules.push(normalizedRule);
|
|
78
|
+
}
|
|
79
|
+
catch (error) {
|
|
80
|
+
errors.push({
|
|
81
|
+
message: `Rule "${key}": ${error.message}`,
|
|
82
|
+
path: key,
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
return { errors, rules };
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Validates assertions in a rule
|
|
90
|
+
*/
|
|
91
|
+
validateAssertions(rule, name, errors) {
|
|
92
|
+
if (!rule.assertions || typeof rule.assertions !== 'object') {
|
|
93
|
+
errors.push({
|
|
94
|
+
message: `Rule "${name}": assertions must be an object`,
|
|
95
|
+
path: `${name}.assertions`,
|
|
96
|
+
});
|
|
97
|
+
return;
|
|
98
|
+
}
|
|
99
|
+
for (const [assertionType, _assertionConfig] of Object.entries(rule.assertions)) {
|
|
100
|
+
try {
|
|
101
|
+
switch (assertionType) {
|
|
102
|
+
case 'swap':
|
|
103
|
+
// validation logic from CLI
|
|
104
|
+
break;
|
|
105
|
+
case 'pattern':
|
|
106
|
+
// logic
|
|
107
|
+
break;
|
|
108
|
+
case 'max-line-length':
|
|
109
|
+
case 'no-trailing-spaces':
|
|
110
|
+
case 'bullet-style':
|
|
111
|
+
case 'semantic-line-breaks':
|
|
112
|
+
case 'no-hard-tabs':
|
|
113
|
+
case 'no-duplicate-headings':
|
|
114
|
+
// Built-in assertions are validated by JSON Schema
|
|
115
|
+
// Additional semantic validation can be added here if needed
|
|
116
|
+
break;
|
|
117
|
+
default:
|
|
118
|
+
errors.push({
|
|
119
|
+
message: `Rule "${name}": unknown assertion type "${assertionType}"`,
|
|
120
|
+
path: `${name}.assertions.${assertionType}`,
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
catch (error) {
|
|
125
|
+
errors.push({
|
|
126
|
+
message: `Rule "${name}": error validating assertion "${assertionType}": ${error.message}`,
|
|
127
|
+
path: `${name}.assertions.${assertionType}`,
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Full validation pipeline
|
|
134
|
+
*/
|
|
135
|
+
validate(config) {
|
|
136
|
+
// First validate structure
|
|
137
|
+
const structureErrors = this.validateStructure(config);
|
|
138
|
+
if (structureErrors.length > 0) {
|
|
139
|
+
return {
|
|
140
|
+
isValid: false,
|
|
141
|
+
errors: structureErrors,
|
|
142
|
+
rules: [],
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
// Then validate semantics
|
|
146
|
+
const { errors: semanticErrors, rules } = this.validateSemantics(config);
|
|
147
|
+
return {
|
|
148
|
+
isValid: semanticErrors.length === 0,
|
|
149
|
+
errors: semanticErrors,
|
|
150
|
+
rules,
|
|
151
|
+
};
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
//# sourceMappingURL=validate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,GAAuB,MAAM,KAAK,CAAC;AAC1C,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAIlC,MAAM,OAAO,eAAe;IAI1B,YAAoB,MAAiB;QAH7B;;;;;WAAS;QACT;;;;;WAAkB;QAGxB,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC;YACjB,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACH,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM;QACjB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9E,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QACjE,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,MAAW;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAY,CAAC;QAE1C,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1C,OAAO,EAAE,GAAG,KAAK,CAAC,YAAY,IAAI,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE;gBACzD,IAAI,EAAE,KAAK,CAAC,YAAY;gBACxB,KAAK,EAAE,KAAK,CAAC,IAAI;aAClB,CAAC,CAAC,CAAC;QACN,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,MAAqB;QAIrC,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,KAAK,GAAqB,EAAE,CAAC;QAEnC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC;gBACH,4BAA4B;gBAC5B,MAAM,IAAI,GAAG,GAAG,CAAC;gBACjB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAEhD,qCAAqC;gBACrC,MAAM,gBAAgB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;gBAClE,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,CAAC,IAAI,CAAC;wBACV,OAAO,EAAE,SAAS,IAAI,wDAAwD,gBAAgB,EAAE;wBAChG,IAAI,EAAE,GAAG,IAAI,UAAU;qBACxB,CAAC,CAAC;gBACL,CAAC;gBAED,wBAAwB;gBACxB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE5C,yBAAyB;gBACzB,MAAM,cAAc,GAAmB;oBACrC,GAAG,IAAI;oBACP,IAAI;oBACJ,SAAS;iBACV,CAAC;gBAEF,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC7B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC;oBACV,OAAO,EAAE,SAAS,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE;oBAC1C,IAAI,EAAE,GAAG;iBACV,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,IAAc,EAAE,IAAY,EAAE,MAAyB;QAChF,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC5D,MAAM,CAAC,IAAI,CAAC;gBACV,OAAO,EAAE,SAAS,IAAI,iCAAiC;gBACvD,IAAI,EAAE,GAAG,IAAI,aAAa;aAC3B,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAChF,IAAI,CAAC;gBACH,QAAQ,aAAa,EAAE,CAAC;oBACtB,KAAK,MAAM;wBACT,4BAA4B;wBAC5B,MAAM;oBACR,KAAK,SAAS;wBACZ,QAAQ;wBACR,MAAM;oBACR,KAAK,iBAAiB,CAAC;oBACvB,KAAK,oBAAoB,CAAC;oBAC1B,KAAK,cAAc,CAAC;oBACpB,KAAK,sBAAsB,CAAC;oBAC5B,KAAK,cAAc,CAAC;oBACpB,KAAK,uBAAuB;wBAC1B,mDAAmD;wBACnD,6DAA6D;wBAC7D,MAAM;oBACR;wBACE,MAAM,CAAC,IAAI,CAAC;4BACV,OAAO,EAAE,SAAS,IAAI,8BAA8B,aAAa,GAAG;4BACpE,IAAI,EAAE,GAAG,IAAI,eAAe,aAAa,EAAE;yBAC5C,CAAC,CAAC;gBACP,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC;oBACV,OAAO,EAAE,SAAS,IAAI,kCAAkC,aAAa,MAAM,KAAK,CAAC,OAAO,EAAE;oBAC1F,IAAI,EAAE,GAAG,IAAI,eAAe,aAAa,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAW;QAKlB,2BAA2B;QAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,eAAe;gBACvB,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC;QAED,0BAA0B;QAC1B,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAuB,CAAC,CAAC;QAE1F,OAAO;YACL,OAAO,EAAE,cAAc,CAAC,MAAM,KAAK,CAAC;YACpC,MAAM,EAAE,cAAc;YACtB,KAAK;SACN,CAAC;IACJ,CAAC;CACF"}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@redocly/recheck",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Content linting (configurable + built-in rules)",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"recheck": "dist/cli.js"
|
|
9
|
+
},
|
|
10
|
+
"keywords": [
|
|
11
|
+
"content",
|
|
12
|
+
"linting",
|
|
13
|
+
"markdown",
|
|
14
|
+
"documentation"
|
|
15
|
+
],
|
|
16
|
+
"author": "Redocly",
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"dependencies": {
|
|
19
|
+
"@redocly/ajv": "8.11.4",
|
|
20
|
+
"ajv-formats": "^2.1.1",
|
|
21
|
+
"colorette": "2.0.20",
|
|
22
|
+
"js-yaml": "4.1.0",
|
|
23
|
+
"picomatch": "2.3.1",
|
|
24
|
+
"yargs": "^17.7.2"
|
|
25
|
+
},
|
|
26
|
+
"devDependencies": {
|
|
27
|
+
"@types/js-yaml": "^4.0.9",
|
|
28
|
+
"@types/picomatch": "2.3.4",
|
|
29
|
+
"@types/node": "22.18.13",
|
|
30
|
+
"@types/yargs": "^17.0.32",
|
|
31
|
+
"@vitest/coverage-v8": "^3.1.1",
|
|
32
|
+
"typescript": "5.9.3",
|
|
33
|
+
"vitest": "^3.1.1"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "tsc",
|
|
37
|
+
"dev": "tsc --watch",
|
|
38
|
+
"start": "node dist/cli.js",
|
|
39
|
+
"test": "vitest run",
|
|
40
|
+
"test:watch": "vitest",
|
|
41
|
+
"validate": "node dist/cli.js validate"
|
|
42
|
+
}
|
|
43
|
+
}
|