@redocly/recheck 0.1.0 → 0.3.0

package/dist/parser/markdoc/schema.js

@@ -0,0 +1,86 @@
+// Recheck's own YAML-serializable Markdoc schema format, deliberately not
+// Markdoc's own `Config['tags']` shape: class-typed attributes and `validate()`
+// functions cannot round-trip through a user's recheck.yaml or be diffed and
+// committed as plain data. This module holds the types, the resolver that turns
+// the boolean or object config form into `{ enabled, schema }`, and the one
+// place that reads a schema back out for the pairing pass. Converting a real
+// Markdoc `Config['tags']` map into this format happens elsewhere, in
+// `scripts/generate-markdoc-schema.mjs`, which produces the committed
+// `src/data/markdoc-realm-schema.ts` re-exported below.
+import { MARKDOC_REALM_SCHEMA } from '../../data/markdoc-realm-schema.js';
+/**
+ * Merges a user's tags over a base schema's tags, in precedence order
+ * base -> file -> inline: inline `extend.tags` wins a collision with a
+ * `tagsFile` entry, which in turn wins over a built-in tag, since the more
+ * specific/local a source is, the more likely a project meant it to override.
+ * A name collision replaces the whole tag rather than deep-merging attribute
+ * by attribute, which matches how Markdoc's own `mergeConfig` composes its
+ * built-in tags with a project's: a tag definition is an atomic unit there,
+ * and `extend` follows the same rule rather than inventing a different merge
+ * granularity.
+ */
+function mergeExtend(base, extend) {
+    if (!extend)
+        return base;
+    const { fileTags, tags } = extend;
+    const hasFileTags = fileTags && Object.keys(fileTags).length > 0;
+    const hasTags = tags && Object.keys(tags).length > 0;
+    if (!hasFileTags && !hasTags)
+        return base;
+    return { tags: { ...base.tags, ...fileTags, ...tags } };
+}
+/**
+ * Normalizes the raw `markdoc` config value (boolean shorthand or object form)
+ * into `{ enabled, schema }`. It is called from `config/validate.ts` after AJV
+ * structural validation, but the check order there means it still sees the raw
+ * value when validation failed, so it must never throw on a malformed shape
+ * (`{ schema: 'bogus' }`, a bare string): anything unrecognized normalizes to
+ * disabled.
+ *
+ * `schema: false` deliberately is not "fully off". Parsing and pairing still
+ * run, and only the schema-dependent rules (unknown tag, and the
+ * unknown/required/enum attribute checks) go inert for lack of anything to check
+ * against. `extend` alongside `schema: false` is accepted structurally but has
+ * no effect, since there is no base to merge over.
+ *
+ * `resolvedExtend`, when passed, is the caller's already-loaded view of
+ * `extend` (`tagsFile` read and shape-checked, see config/validate.ts) and
+ * takes over from `raw.extend` entirely -- this module never reads a
+ * `tagsFile` itself, so a caller that resolved one has strictly more
+ * information than `raw.extend` alone.
+ */
+export function resolveMarkdocConfig(raw, resolvedExtend) {
+    if (raw === true) {
+        return { enabled: true, schema: MARKDOC_REALM_SCHEMA };
+    }
+    if (raw !== null && typeof raw === 'object') {
+        if (raw.schema === false) {
+            return { enabled: true, schema: null };
+        }
+        if (raw.schema === 'realm') {
+            return {
+                enabled: true,
+                schema: mergeExtend(MARKDOC_REALM_SCHEMA, resolvedExtend ?? raw.extend),
+            };
+        }
+        // Malformed object (e.g. `schema: 'bogus'`). AJV already reports this as a
+        // structural error, so defensively disable rather than throw.
+        return { enabled: false, schema: null };
+    }
+    // `undefined`, `false`, or any invalid non-boolean/non-object value.
+    return { enabled: false, schema: null };
+}
+/**
+ * Tag names a schema declares self-closing, in the plain `Set<string>` shape
+ * `pairing.ts` consumes so the pairing pass depends on none of this module's
+ * types.
+ */
+export function selfClosingTagNames(schema) {
+    const names = new Set();
+    for (const [name, tag] of Object.entries(schema.tags)) {
+        if (tag.selfClosing)
+            names.add(name);
+    }
+    return names;
+}
+//# sourceMappingURL=schema.js.map

package/dist/parser/markdoc/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/parser/markdoc/schema.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,gFAAgF;AAChF,6EAA6E;AAC7E,gFAAgF;AAChF,4EAA4E;AAC5E,6EAA6E;AAC7E,sEAAsE;AACtE,sEAAsE;AACtE,wDAAwD;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAgE1E;;;;;;;;;;GAUG;AACH,SAAS,WAAW,CAAC,IAAmB,EAAE,MAAkC;IAC1E,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAClC,MAAM,WAAW,GAAG,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,IAAI,CAAC,WAAW,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1C,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAA4C,EAC5C,cAA+B;IAK/B,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;IACzD,CAAC;IACD,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YACzB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACzC,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,WAAW,CAAC,oBAAoB,EAAE,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC;aACxE,CAAC;QACJ,CAAC;QACD,2EAA2E;QAC3E,8DAA8D;QAC9D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC;IACD,qEAAqE;IACrE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAqB;IACvD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,IAAI,GAAG,CAAC,WAAW;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/parser/markdoc/span.d.ts

@@ -0,0 +1,64 @@
+export type MarkdocTagKind = 'tag-open' | 'tag-close' | 'tag-self-closing' | 'annotation' | 'variable' | 'function';
+export type MarkdocValueKind = 'string' | 'number' | 'boolean' | 'null' | 'array' | 'object' | 'variable' | 'function' | 'bareword';
+export interface MarkdocAttribute {
+    name: string;
+    valueKind: MarkdocValueKind;
+    /** Literal value for string/number/boolean/null; raw source text otherwise. */
+    value: string | number | boolean | null;
+    /** 0-based offsets into the SPAN text, for child-token synthesis. */
+    nameStart: number;
+    nameEnd: number;
+    valueStart: number;
+    valueEnd: number;
+}
+/**
+ * A class (`.foo`) or id (`#bar`) shortcut inside a named tag's attribute list.
+ * Markdoc folds these into `class`/`id` attributes on the AST node; this parser
+ * keeps them in their own list instead, because a shortcut has no `name=value`
+ * source text and a pseudo attribute entry would carry lying offsets. Folding
+ * them into `class`/`id` is a schema-aware concern, not this parser's.
+ */
+export interface MarkdocShortcut {
+    kind: 'class' | 'id';
+    name: string;
+    start: number;
+    end: number;
+}
+export interface ParsedMarkdocSpan {
+    kind: MarkdocTagKind | 'malformed';
+    name: string | null;
+    attributes: MarkdocAttribute[];
+    nameStart: number;
+    nameEnd: number;
+    /** Markdoc's positional value slot right after the tag name ({% if $flag %}).
+     * Real Markdoc assigns it to the schema attribute literally named `primary`. */
+    primary?: {
+        valueKind: MarkdocValueKind;
+        value: string | number | boolean | null;
+        valueStart: number;
+        valueEnd: number;
+    };
+    /**
+     * Class/id shortcuts from a NAMED tag's attribute list, in source order.
+     * Absent (not an empty array) when none were found.
+     */
+    shortcuts?: MarkdocShortcut[];
+    reason?: string;
+    /**
+     * `malformed` only, and only when the scanner knew where it gave up: the
+     * 0-based span offset of the offending character. Kept as a number rather
+     * than baked into `reason` so a consumer can translate it into an absolute
+     * document position. Absent for causes with no single meaningful position,
+     * such as an empty body or a missing delimiter.
+     */
+    reasonOffset?: number;
+}
+/**
+ * Parses one Markdoc `{% ... %}` span's text into its kind, name,
+ * attributes, and offsets. `spanText` is expected to be exactly the span
+ * (e.g. as recognized by the tokenizer) -- offsets in the result are
+ * 0-based indexes into this same string. Never throws; unparseable input
+ * comes back as `{ kind: 'malformed', reason }`.
+ */
+export declare function parseMarkdocSpan(spanText: string): ParsedMarkdocSpan;
+//# sourceMappingURL=span.d.ts.map

package/dist/parser/markdoc/span.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"span.d.ts","sourceRoot":"","sources":["../../../src/parser/markdoc/span.ts"],"names":[],"mappings":"AAsEA,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,UAAU,GACV,UAAU,CAAC;AACf,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,QAAQ,GACR,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,gBAAgB,CAAC;IAC5B,+EAA+E;IAC/E,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IACxC,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,cAAc,GAAG,WAAW,CAAC;IACnC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB;oFACgF;IAChF,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,gBAAgB,CAAC;QAC5B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;QACxC,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAgeD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAyNpE"}