frontmatter-kit 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,68 @@
+export type FrontmatterLanguage = "yaml" | "json" | "toml";
+export type FrontmatterSeverity = "info" | "warning" | "error";
+export type FrontmatterValue = string | number | boolean | null | FrontmatterValue[] | {
+    [key: string]: FrontmatterValue;
+};
+export type FrontmatterAttributes = Record<string, FrontmatterValue>;
+export interface FrontmatterPosition {
+    offset: number;
+    line: number;
+    column: number;
+}
+export interface FrontmatterRange {
+    start: FrontmatterPosition;
+    end: FrontmatterPosition;
+}
+export interface FrontmatterDiagnostic {
+    code: string;
+    severity: FrontmatterSeverity;
+    message: string;
+    range?: FrontmatterRange | undefined;
+}
+export interface FrontmatterRanges {
+    opening?: FrontmatterRange;
+    matter?: FrontmatterRange;
+    closing?: FrontmatterRange;
+    body: FrontmatterRange;
+    excerpt?: FrontmatterRange;
+}
+export interface FrontmatterDelimiters {
+    opening: string;
+    closing: string;
+}
+export interface FrontmatterParseOptions {
+    /**
+     * Force a front matter language instead of inferring it from the opening
+     * marker. `+++` still defaults to TOML when this option is omitted.
+     */
+    language?: FrontmatterLanguage;
+    /**
+     * Marker used to derive the optional excerpt.
+     *
+     * @default "<!-- more -->"
+     */
+    excerptSeparator?: string | false;
+}
+export interface FrontmatterStringifyOptions {
+    language?: FrontmatterLanguage;
+    delimiter?: "---" | "+++";
+}
+export interface FrontmatterResult<TAttributes extends FrontmatterAttributes = FrontmatterAttributes> {
+    hasFrontmatter: boolean;
+    attributes: TAttributes;
+    body: string;
+    matter: string;
+    language?: FrontmatterLanguage;
+    delimiters?: FrontmatterDelimiters;
+    excerpt?: string | undefined;
+    ranges: FrontmatterRanges;
+    diagnostics: FrontmatterDiagnostic[];
+}
+export type FrontmatterTryResult<TAttributes extends FrontmatterAttributes = FrontmatterAttributes> = {
+    ok: true;
+    result: FrontmatterResult<TAttributes>;
+} | {
+    ok: false;
+    error: Error;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAE/D,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,gBAAgB,EAAE,GAClB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC;AAExC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,mBAAmB,CAAC;IAC3B,GAAG,EAAE,mBAAmB,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CACnC;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,qBAAqB,GAAG,qBAAqB;IAClG,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,WAAW,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,EAAE,iBAAiB,CAAC;IAC1B,WAAW,EAAE,qBAAqB,EAAE,CAAC;CACtC;AAED,MAAM,MAAM,oBAAoB,CAAC,WAAW,SAAS,qBAAqB,GAAG,qBAAqB,IAC9F;IACE,EAAE,EAAE,IAAI,CAAC;IACT,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;CACxC,GACD;IACE,EAAE,EAAE,KAAK,CAAC;IACV,KAAK,EAAE,KAAK,CAAC;CACd,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "frontmatter-kit",
+  "version": "0.1.0",
+  "description": "Parse and inspect front matter with typed metadata, body ranges and readable diagnostics.",
+  "type": "module",
+  "sideEffects": false,
+  "license": "MPL-2.0",
+  "author": "Recoveredd",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Recoveredd/frontmatter-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Recoveredd/frontmatter-kit/issues"
+  },
+  "homepage": "https://github.com/Recoveredd/frontmatter-kit#readme",
+  "keywords": [
+    "frontmatter",
+    "front-matter",
+    "markdown",
+    "yaml",
+    "toml",
+    "json",
+    "parser",
+    "typescript"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prepack": "npm run build",
+    "test": "vitest run --config vitest.config.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
+  }
+}