@redocly/recheck 0.15.0 → 2.58.0

package/lib/config/schema.d.ts

@@ -0,0 +1,215 @@
+export declare const MARKDOC_TAG_SCHEMA: {
+    type: string;
+    properties: {
+        selfClosing: {
+            type: string;
+        };
+        attributes: {
+            type: string;
+            additionalProperties: {
+                type: string;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    required: {
+                        type: string;
+                    };
+                    default: {
+                        oneOf: {
+                            type: string;
+                        }[];
+                    };
+                    enum: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        minItems: number;
+                    };
+                    dynamic: {
+                        type: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
+        };
+    };
+    additionalProperties: boolean;
+};
+export declare const RECHECK_CONFIG_SCHEMA: {
+    $schema: string;
+    type: string;
+    properties: {
+        excludes: {
+            type: string;
+            items: {
+                type: string;
+                minLength: number;
+            };
+        };
+        markdoc: {
+            if: {
+                type: string;
+            };
+            then: {
+                type: string;
+                properties: {
+                    schema: {
+                        enum: (string | boolean)[];
+                    };
+                    extend: {
+                        type: string;
+                        properties: {
+                            tags: {
+                                type: string;
+                                additionalProperties: {
+                                    type: string;
+                                    properties: {
+                                        selfClosing: {
+                                            type: string;
+                                        };
+                                        attributes: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                                properties: {
+                                                    type: {
+                                                        enum: string[];
+                                                    };
+                                                    required: {
+                                                        type: string;
+                                                    };
+                                                    default: {
+                                                        oneOf: {
+                                                            type: string;
+                                                        }[];
+                                                    };
+                                                    enum: {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                        minItems: number;
+                                                    };
+                                                    dynamic: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                additionalProperties: boolean;
+                                            };
+                                        };
+                                    };
+                                    additionalProperties: boolean;
+                                };
+                            };
+                            tagsFile: {
+                                type: string;
+                                minLength: number;
+                            };
+                        };
+                        anyOf: {
+                            required: string[];
+                        }[];
+                        additionalProperties: boolean;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
+            else: {
+                type: string;
+            };
+        };
+    };
+    patternProperties: {
+        '^[a-z][a-z0-9-]*/[a-z0-9-_]+$': {
+            type: string;
+            properties: {
+                severity: {
+                    type: string;
+                    enum: string[];
+                    default: string;
+                };
+                message: {
+                    type: string;
+                    minLength: number;
+                };
+                fix: {
+                    type: string;
+                };
+                tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                description: {
+                    type: string;
+                };
+                link: {
+                    type: string;
+                    format: string;
+                };
+                scope: {
+                    oneOf: ({
+                        type: string;
+                        minLength: number;
+                        items?: undefined;
+                        minItems?: undefined;
+                    } | {
+                        type: string;
+                        items: {
+                            type: string;
+                            minLength: number;
+                        };
+                        minItems: number;
+                        minLength?: undefined;
+                    })[];
+                    default: string;
+                };
+                appliesTo: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                excludes: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                exceptions: {
+                    type: string;
+                    properties: {
+                        files: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                        lines: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+                assertions: {
+                    type: string;
+                    additionalProperties: boolean;
+                    minProperties: number;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    additionalProperties: boolean;
+};
+//# sourceMappingURL=schema.d.ts.map

package/lib/config/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAU9B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4HjC,CAAC"}

package/lib/config/schema.js

@@ -0,0 +1,152 @@
+// Shape of one Markdoc tag attribute. It matches `MarkdocAttributeSchema` in
+// parser/markdoc/schema.ts. Unknown keys are errors.
+const MARKDOC_ATTRIBUTE_SCHEMA = {
+    type: 'object',
+    properties: {
+        type: { enum: ['string', 'number', 'boolean'] },
+        required: { type: 'boolean' },
+        // `oneOf` instead of a `type` array, because AJV strict mode warns about the array form.
+        default: { oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }] },
+        enum: { type: 'array', items: { type: 'string' }, minItems: 1 },
+        dynamic: { type: 'boolean' },
+    },
+    required: ['type'],
+    additionalProperties: false,
+};
+export const MARKDOC_TAG_SCHEMA = {
+    type: 'object',
+    properties: {
+        selfClosing: { type: 'boolean' },
+        attributes: {
+            type: 'object',
+            additionalProperties: MARKDOC_ATTRIBUTE_SCHEMA,
+        },
+    },
+    additionalProperties: false,
+};
+export const RECHECK_CONFIG_SCHEMA = {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    type: 'object',
+    properties: {
+        // Applies to every rule, before each rule's own `excludes`. Not a rule.
+        excludes: {
+            type: 'array',
+            items: { type: 'string', minLength: 1 },
+        },
+        // Off by default, because Liquid and Jinja use the same {% %} delimiters.
+        // `true` means `{ schema: 'realm' }`. `schema: false` parses Markdoc without
+        // checking tags against a schema.
+        //
+        // Uses `if`/`then`/`else` instead of `oneOf: [boolean, object]`, because
+        // `oneOf` would also report "must be boolean" for an invalid object.
+        markdoc: {
+            if: { type: 'object' },
+            then: {
+                type: 'object',
+                properties: {
+                    schema: { enum: ['realm', false] },
+                    extend: {
+                        type: 'object',
+                        properties: {
+                            tags: { type: 'object', additionalProperties: MARKDOC_TAG_SCHEMA },
+                            // YAML file of tag schemas, relative to the config file. Inline `tags` win over it.
+                            tagsFile: { type: 'string', minLength: 1 },
+                        },
+                        anyOf: [{ required: ['tags'] }, { required: ['tagsFile'] }],
+                        additionalProperties: false,
+                    },
+                },
+                required: ['schema'],
+                additionalProperties: false,
+            },
+            else: { type: 'boolean' },
+        },
+    },
+    patternProperties: {
+        // Rule keys are `<namespace>/<name>`, for example `recheck/x` or
+        // `google/no-latinisms`. Presets use their own namespace so they can be
+        // combined without key clashes.
+        '^[a-z][a-z0-9-]*/[a-z0-9-_]+$': {
+            type: 'object',
+            properties: {
+                severity: {
+                    type: 'string',
+                    enum: ['off', 'info', 'warn', 'error'],
+                    default: 'error',
+                },
+                message: {
+                    type: 'string',
+                    minLength: 1,
+                },
+                fix: {
+                    type: 'boolean',
+                },
+                tags: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                description: {
+                    type: 'string',
+                },
+                link: {
+                    type: 'string',
+                    format: 'uri',
+                },
+                // Only the shape is checked here. validate.ts checks each scope term
+                // afterwards, so it can give a better error message.
+                scope: {
+                    oneOf: [
+                        { type: 'string', minLength: 1 },
+                        {
+                            type: 'array',
+                            items: { type: 'string', minLength: 1 },
+                            minItems: 1,
+                        },
+                    ],
+                    default: 'all',
+                },
+                appliesTo: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                excludes: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                exceptions: {
+                    type: 'object',
+                    properties: {
+                        files: {
+                            type: 'array',
+                            items: {
+                                type: 'string',
+                            },
+                        },
+                        lines: {
+                            type: 'array',
+                            items: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                    additionalProperties: false,
+                },
+                assertions: {
+                    type: 'object',
+                    additionalProperties: true,
+                    minProperties: 1,
+                },
+            },
+            required: ['severity', 'message', 'assertions'],
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=schema.js.map

package/lib/config/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,qDAAqD;AACrD,MAAM,wBAAwB,GAAG;IAC/B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE;QAC/C,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC7B,yFAAyF;QACzF,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE;QACjF,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC/D,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;KAC7B;IACD,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAChC,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,wBAAwB;SAC/C;KACF;IACD,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,yCAAyC;IAClD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,wEAAwE;QACxE,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;SACxC;QACD,0EAA0E;QAC1E,6EAA6E;QAC7E,kCAAkC;QAClC,EAAE;QACF,yEAAyE;QACzE,qEAAqE;QACrE,OAAO,EAAE;YACP,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;oBAClC,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,kBAAkB,EAAE;4BAClE,oFAAoF;4BACpF,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;yBAC3C;wBACD,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;wBAC3D,oBAAoB,EAAE,KAAK;qBAC5B;iBACF;gBACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;gBACpB,oBAAoB,EAAE,KAAK;aAC5B;YACD,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;SAC1B;KACF;IACD,iBAAiB,EAAE;QACjB,iEAAiE;QACjE,wEAAwE;QACxE,gCAAgC;QAChC,+BAA+B,EAAE;YAC/B,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;oBACtC,OAAO,EAAE,OAAO;iBACjB;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,CAAC;iBACb;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,SAAS;iBAChB;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;iBACf;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,KAAK;iBACd;gBACD,qEAAqE;gBACrE,qDAAqD;gBACrD,KAAK,EAAE;oBACL,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;wBAChC;4BACE,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;4BACvC,QAAQ,EAAE,CAAC;yBACZ;qBACF;oBACD,OAAO,EAAE,KAAK;iBACf;gBACD,SAAS,EAAE;oBACT,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;6BACf;yBACF;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;oBACD,oBAAoB,EAAE,KAAK;iBAC5B;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,IAAI;oBAC1B,aAAa,EAAE,CAAC;iBACjB;aACF;YACD,QAAQ,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;YAC/C,oBAAoB,EAAE,KAAK;SAC5B;KACF;IACD,oBAAoB,EAAE,KAAK;CAC5B,CAAC"}

package/lib/config/validate.d.ts

@@ -0,0 +1,19 @@
+import { type MarkdocSchema } from '../parser/markdoc/schema.js';
+import type { NormalizedRule, ValidationError } from '../types/index.js';
+/**
+ * Validates a config. `options.configDir` (default `process.cwd()`) is where a relative
+ * `markdoc.extend.tagsFile` resolves from.
+ */
+export declare function validate(config: any, options?: {
+    configDir?: string;
+    warn?: (message: string) => void;
+}): Promise<{
+    isValid: boolean;
+    errors: ValidationError[];
+    rules: NormalizedRule[];
+    markdoc: {
+        enabled: boolean;
+        schema: MarkdocSchema | null;
+    };
+}>;
+//# sourceMappingURL=validate.d.ts.map

package/lib/config/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/config/validate.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,KAAK,aAAa,EAInB,MAAM,6BAA6B,CAAC;AAMrC,OAAO,KAAK,EAAgB,cAAc,EAAE,eAAe,EAAY,MAAM,mBAAmB,CAAC;AAirCjG;;;GAGG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,GAAG,EACX,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,GACjE,OAAO,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,KAAK,EAAE,cAAc,EAAE,CAAC;IAGxB,OAAO,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAA;KAAE,CAAC;CAC7D,CAAC,CA0FD"}