@flint.fyi/markdown-language 0.0.0

package/README.md

@@ -0,0 +1,9 @@
+<h1 align="center"><code>@flint.fyi/markdown-language</code></h1>
+
+<p align="center">
+	[Experimental] Markdown language for Flint.
+	❤️‍🔥
+</p>
+
+This is an internal package for Flint.
+Documentation will eventually be added.

package/lib/createMarkdownFile.d.ts

@@ -0,0 +1,8 @@
+import type { FileDiskData, LanguageFileDefinition } from "@flint.fyi/core";
+import type { MarkdownFileServices } from "./language.ts";
+import type { MarkdownNodesByName } from "./nodes.ts";
+export declare function createMarkdownFile(data: FileDiskData): {
+    languageFile: LanguageFileDefinition<MarkdownNodesByName, MarkdownFileServices>;
+    root: import("mdast").Root;
+};
+//# sourceMappingURL=createMarkdownFile.d.ts.map

package/lib/createMarkdownFile.js

@@ -0,0 +1,33 @@
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { gfmFromMarkdown } from "mdast-util-gfm";
+import { gfm } from "micromark-extension-gfm";
+import { visit } from "unist-util-visit";
+
+//#region src/createMarkdownFile.ts
+function createMarkdownFile(data) {
+	const root = fromMarkdown(data.sourceText, {
+		extensions: [gfm()],
+		mdastExtensions: [gfmFromMarkdown()]
+	});
+	return {
+		languageFile: {
+			about: data,
+			runVisitors(options, runtime) {
+				if (!runtime.visitors) return;
+				const { visitors } = runtime;
+				const fileServices = {
+					options,
+					root
+				};
+				visit(root, (node) => {
+					visitors[node.type]?.(node, fileServices);
+				});
+			}
+		},
+		root
+	};
+}
+
+//#endregion
+export { createMarkdownFile };
+//# sourceMappingURL=createMarkdownFile.js.map

package/lib/directives/parseDirectivesFromMarkdownFile.d.ts

@@ -0,0 +1,6 @@
+import type { Root } from "mdast";
+export declare function parseDirectivesFromMarkdownFile(root: Root, sourceText: string): {
+    directives: import("@flint.fyi/core").CommentDirective[];
+    reports: import("@flint.fyi/core").FileReport[];
+};
+//# sourceMappingURL=parseDirectivesFromMarkdownFile.d.ts.map

package/lib/directives/parseDirectivesFromMarkdownFile.js

@@ -0,0 +1,35 @@
+import { DirectivesCollector } from "@flint.fyi/core";
+import { visit } from "unist-util-visit";
+import { nullThrows } from "@flint.fyi/utils";
+
+//#region src/directives/parseDirectivesFromMarkdownFile.ts
+function parseDirectivesFromMarkdownFile(root, sourceText) {
+	const collector = new DirectivesCollector(root.children.find((child) => child.position?.start.offset !== void 0)?.position?.start.offset ?? sourceText.length);
+	visit(root, "html", (node) => {
+		const regex = /<!--([\s\S]*?)-->/g;
+		let commentMatch;
+		while ((commentMatch = regex.exec(node.value)) !== null) {
+			const directiveMatch = /^\s*flint-(\S+)(?:\s+(.+))?/.exec(nullThrows(commentMatch[1], "Directive match is expected to be present by the regex match"));
+			if (!directiveMatch) return;
+			const position = nullThrows(node.position, "Node position is expected to be present");
+			const [type, selection] = directiveMatch.slice(1);
+			collector.add({
+				begin: {
+					column: position.start.column - 1,
+					line: position.start.line - 1,
+					raw: nullThrows(position.start.offset, "Node start offset is expected to be present")
+				},
+				end: {
+					column: position.end.column - 1,
+					line: position.end.line - 1,
+					raw: nullThrows(position.end.offset, "Node end offset is expected to be present")
+				}
+			}, nullThrows(selection, "Selection is expected to be present by the regex match"), nullThrows(type, "Type is expected to be present by the regex match"));
+		}
+	});
+	return collector.collect();
+}
+
+//#endregion
+export { parseDirectivesFromMarkdownFile };
+//# sourceMappingURL=parseDirectivesFromMarkdownFile.js.map

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { MarkdownNodesByName, PointWithOffset, PositionWithOffsets, RootContentMapWithChildren, WithPosition } from "./nodes.js";
+import { MarkdownFileServices, markdownLanguage } from "./language.js";
+export { MarkdownFileServices, MarkdownNodesByName, PointWithOffset, PositionWithOffsets, RootContentMapWithChildren, WithPosition, markdownLanguage };

package/lib/index.js

@@ -0,0 +1,3 @@
+import { markdownLanguage } from "./language.js";
+
+export { markdownLanguage };

package/lib/language.d.ts

@@ -0,0 +1,12 @@
+import { MarkdownNodesByName, WithPosition } from "./nodes.js";
+import * as _flint_fyi_core0 from "@flint.fyi/core";
+import * as mdast from "mdast";
+
+//#region src/language.d.ts
+interface MarkdownFileServices {
+  root: WithPosition<mdast.Root>;
+}
+declare const markdownLanguage: _flint_fyi_core0.Language<MarkdownNodesByName, MarkdownFileServices>;
+//#endregion
+export { MarkdownFileServices, markdownLanguage };
+//# sourceMappingURL=language.d.ts.map

package/lib/language.js

@@ -0,0 +1,29 @@
+import { createMarkdownFile } from "./createMarkdownFile.js";
+import { prepareMarkdownFile } from "./prepareMarkdownFile.js";
+import { createLanguage } from "@flint.fyi/core";
+import fsSync from "node:fs";
+
+//#region src/language.ts
+const markdownLanguage = createLanguage({
+	about: { name: "Markdown" },
+	createFileFactory: () => {
+		return {
+			prepareFromDisk: (data) => {
+				const sourceText = fsSync.readFileSync(data.filePathAbsolute, "utf8");
+				const { languageFile, root } = createMarkdownFile({
+					...data,
+					sourceText
+				});
+				return prepareMarkdownFile(languageFile, root, sourceText);
+			},
+			prepareFromVirtual: (data) => {
+				const { languageFile, root } = createMarkdownFile(data);
+				return prepareMarkdownFile(languageFile, root, data.sourceText);
+			}
+		};
+	}
+});
+
+//#endregion
+export { markdownLanguage };
+//# sourceMappingURL=language.js.map

package/lib/nodes.d.ts

@@ -0,0 +1,30 @@
+import * as mdast from "mdast";
+import { Point, Position } from "unist";
+
+//#region src/nodes.d.ts
+interface MarkdownNodesByName extends RootContentMapWithChildren {
+  root: WithPosition<mdast.Root>;
+}
+/**
+ * A version of {@link Point} where the `offset` always exists.
+ */
+interface PointWithOffset extends Point {
+  offset: number;
+}
+/**
+ * A version of {@link Position} where the `end` and `start` points include offsets.
+ */
+interface PositionWithOffsets extends Position {
+  end: PointWithOffset;
+  start: PointWithOffset;
+}
+/**
+ * A version of {@link mdast.RootContentMap} that includes position information for each node.
+ */
+type RootContentMapWithChildren = { [K in keyof mdast.RootContentMap]: WithPosition<mdast.RootContentMap[K]> };
+type WithPosition<T> = T & {
+  position: PositionWithOffsets;
+};
+//#endregion
+export { MarkdownNodesByName, PointWithOffset, PositionWithOffsets, RootContentMapWithChildren, WithPosition };
+//# sourceMappingURL=nodes.d.ts.map

package/lib/prepareMarkdownFile.d.ts

@@ -0,0 +1,10 @@
+import type { LanguageFileDefinition } from "@flint.fyi/core";
+import type { Root } from "mdast";
+import type { MarkdownFileServices } from "./language.ts";
+import type { MarkdownNodesByName } from "./nodes.ts";
+export declare function prepareMarkdownFile(languageFile: LanguageFileDefinition<MarkdownNodesByName, MarkdownFileServices>, root: Root, sourceText: string): {
+    file: LanguageFileDefinition<MarkdownNodesByName, MarkdownFileServices>;
+    directives: import("@flint.fyi/core").CommentDirective[];
+    reports: import("@flint.fyi/core").FileReport[];
+};
+//# sourceMappingURL=prepareMarkdownFile.d.ts.map

package/lib/prepareMarkdownFile.js

@@ -0,0 +1,13 @@
+import { parseDirectivesFromMarkdownFile } from "./directives/parseDirectivesFromMarkdownFile.js";
+
+//#region src/prepareMarkdownFile.ts
+function prepareMarkdownFile(languageFile, root, sourceText) {
+	return {
+		...parseDirectivesFromMarkdownFile(root, sourceText),
+		file: languageFile
+	};
+}
+
+//#endregion
+export { prepareMarkdownFile };
+//# sourceMappingURL=prepareMarkdownFile.js.map

package/package.json

@@ -0,0 +1,52 @@
+{
+	"name": "@flint.fyi/markdown-language",
+	"version": "0.0.0",
+	"description": "[Experimental] Markdown language for Flint.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/flint-fyi/flint.git",
+		"directory": "packages/markdown-language"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "JoshuaKGoldberg",
+		"email": "npm@joshuakgoldberg.com"
+	},
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"@flint.fyi/source": "./src/index.ts",
+			"default": "./lib/index.js"
+		}
+	},
+	"files": [
+		"lib/",
+		"!lib/**/*.map"
+	],
+	"scripts": {
+		"test": "vitest --typecheck --project markdown-language"
+	},
+	"dependencies": {
+		"@flint.fyi/core": "workspace:^",
+		"@flint.fyi/utils": "workspace:^",
+		"mdast-util-from-markdown": "^2.0.2",
+		"mdast-util-gfm": "^3.1.0",
+		"micromark-extension-gfm": "^3.0.0",
+		"unist-util-visit": "^5.0.0"
+	},
+	"devDependencies": {
+		"@types/unist": "3.0.3",
+		"tsdown": "0.19.0-beta.2",
+		"vitest": "4.0.15"
+	},
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"publishConfig": {
+		"access": "public",
+		"exports": {
+			".": "./lib/index.js"
+		}
+	}
+}