rspress-plugin-api-extractor 0.9.0 → 0.9.2

package/env.d.ts

@@ -99,7 +99,6 @@ interface ImportMetaEnv {
 	readonly DEV: boolean;
 }
 
-// biome-ignore lint/correctness/noUnusedVariables: ImportMeta is used by TypeScript but may appear unused to the linter
 interface ImportMeta {
 	/**
 	 * The `import.meta` object contains metadata about the current module. It is a standard

package/frontmatter.js

@@ -1,4 +1,5 @@
 import { Effect } from "effect";
+import { FrontmatterSource, FrontmatterSourceBlock, FrontmatterSourceSplit } from "@effected/markdown";
 import { Yaml, YamlStringifyOptions } from "@effected/yaml";
 
 //#region src/frontmatter.ts
@@ -6,16 +7,20 @@ import { Yaml, YamlStringifyOptions } from "@effected/yaml";
 * Stringify options shared by both emit sites.
 *
 * `lineWidth: 0` disables wrapping so long titles/descriptions/URLs stay on
-* one line, and `defaultScalarStyle: "double-quoted"` quotes every string
-* value. The forced quoting matters for downstream consumers: RSPress parses
-* the emitted frontmatter with js-yaml (YAML 1.1-flavored), where an unquoted
-* ISO timestamp such as `2024-01-15T12:00:00.000Z` decodes to a `Date` object
-* instead of a string. Quoting every value keeps the decoded representation
-* identical across YAML 1.1 and 1.2 parsers.
+* one line. The quoting matters for downstream consumers: RSPress parses the
+* emitted frontmatter with js-yaml (YAML 1.1-flavored), where an unquoted
+* ISO timestamp such as `2024-01-15T12:00:00.000Z` decodes to a `Date`
+* object instead of a string. `quoteCompat: "yaml-1.1"` quotes exactly the
+* plain scalars a YAML 1.1 resolver would coerce (timestamps, `yes`/`no`/
+* `on`/`off` booleans, legacy octal/sexagesimal numbers), keeping the
+* decoded representation identical across YAML 1.1 and 1.2 parsers without
+* quoting every value; `quoteStyle: "double"` makes the quotes that do
+* appear double quotes.
 */
 const STRINGIFY_OPTIONS = YamlStringifyOptions.make({
 	lineWidth: 0,
-	defaultScalarStyle: "double-quoted"
+	quoteCompat: "yaml-1.1",
+	quoteStyle: "double"
 });
 const OPEN_DELIMITER = "---";
 const CLOSE_SEARCH = "\n---";
@@ -48,6 +53,14 @@ const CLOSE_SEARCH = "\n---";
 * split treats such input as "no frontmatter" instead. The plugin never emits
 * or consumes language-tagged frontmatter.
 *
+* `@effected/markdown`'s `FrontmatterSource.split` was evaluated for this
+* path and deliberately NOT adopted: its grammar is strict by design (a
+* fence line is exactly `---`, an unterminated block is not frontmatter),
+* while this contract pins gray-matter's `indexOf`-based quirks (`\n----`
+* closes, trailing-space close lines close, a missing close means
+* all-frontmatter). The emission half (`stringifyFrontmatter` /
+* `emitFrontmatterBlock`) does use `FrontmatterSource.join`.
+*
 * Representation parity with js-yaml is verified by characterization tests
 * (`__test__/frontmatter.test.ts`) pinning hashes captured under gray-matter.
 * The one input where the engines disagree — an *unquoted* ISO timestamp
@@ -123,7 +136,14 @@ function parseFrontmatter(source) {
 function stringifyFrontmatter(content, data) {
 	const body = content.endsWith("\n") ? content : `${content}\n`;
 	if (Object.keys(data).length === 0) return body;
-	return `---\n${Effect.runSync(Yaml.stringify(data, STRINGIFY_OPTIONS))}---\n${body}`;
+	const yaml = Effect.runSync(Yaml.stringify(data, STRINGIFY_OPTIONS));
+	return FrontmatterSource.join(FrontmatterSourceSplit.make({
+		frontmatter: FrontmatterSourceBlock.make({
+			format: "yaml",
+			value: yaml
+		}),
+		body
+	}));
 }
 /**
 * Serialize a data object to a YAML frontmatter block (fences included, plus
@@ -142,7 +162,14 @@ function stringifyFrontmatter(content, data) {
 * @public
 */
 function emitFrontmatterBlock(data) {
-	return `---\n${Effect.runSync(Yaml.stringify(data, STRINGIFY_OPTIONS))}---\n\n`;
+	const yaml = Effect.runSync(Yaml.stringify(data, STRINGIFY_OPTIONS));
+	return FrontmatterSource.join(FrontmatterSourceSplit.make({
+		frontmatter: FrontmatterSourceBlock.make({
+			format: "yaml",
+			value: yaml
+		}),
+		body: "\n"
+	}));
 }
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rspress-plugin-api-extractor",
-	"version": "0.9.0",
+	"version": "0.9.2",
 	"private": false,
 	"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
 	"keywords": [
@@ -40,20 +40,22 @@
 		"@effect/platform-node": "4.0.0-rc.109",
 		"@effected/github": "^0.8.0",
 		"@effected/glob": "^0.4.0",
+		"@effected/jsonc": "^0.8.0",
+		"@effected/markdown": "^0.7.0",
 		"@effected/npm": "^0.12.0",
-		"@effected/package-json": "^0.11.0",
+		"@effected/package-json": "^0.12.0",
 		"@effected/semver": "^0.5.0",
-		"@effected/store": "^0.4.0",
-		"@effected/tsconfig-json": "^0.6.0",
+		"@effected/store": "^0.5.0",
+		"@effected/tsconfig-json": "^0.6.1",
 		"@effected/walker": "^0.5.0",
 		"@effected/xdg": "^0.3.0",
-		"@effected/yaml": "^0.11.0",
+		"@effected/yaml": "^0.12.0",
 		"@microsoft/api-extractor-model": "^7.33.11",
 		"@shikijs/twoslash": "^4.4.3",
-		"@tsdoctor/bundle": "0.1.0",
-		"@tsdoctor/model": "0.2.0",
+		"@tsdoctor/bundle": "0.2.0",
+		"@tsdoctor/model": "0.2.2",
 		"@tsdoctor/registry": "0.2.0",
-		"@tsdoctor/snapshot": "0.1.0",
+		"@tsdoctor/snapshot": "0.1.1",
 		"@typescript/vfs": "^1.6.4",
 		"clsx": "^2.1.1",
 		"effect": "4.0.0-rc.109",