@flint.fyi/markdown-language 0.0.0 → 0.15.1

package/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/directives/parseDirectivesFromMarkdownFile.js

@@ -1,6 +1,6 @@
 import { DirectivesCollector } from "@flint.fyi/core";
-import { visit } from "unist-util-visit";
 import { nullThrows } from "@flint.fyi/utils";
+import { visit } from "unist-util-visit";
 
 //#region src/directives/parseDirectivesFromMarkdownFile.ts
 function parseDirectivesFromMarkdownFile(root, sourceText) {

package/lib/index.d.ts

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

package/lib/language.d.ts

@@ -6,7 +6,34 @@ import * as mdast from "mdast";
 interface MarkdownFileServices {
   root: WithPosition<mdast.Root>;
 }
-declare const markdownLanguage: _flint_fyi_core0.Language<MarkdownNodesByName, MarkdownFileServices>;
+declare const markdownLanguage: _flint_fyi_core0.Language<_flint_fyi_core0.Simplify<MarkdownNodesByName & {
+  "blockquote:exit"?: WithPosition<mdast.Blockquote>;
+  "break:exit"?: WithPosition<mdast.Break>;
+  "code:exit"?: WithPosition<mdast.Code>;
+  "definition:exit"?: WithPosition<mdast.Definition>;
+  "delete:exit"?: WithPosition<mdast.Delete>;
+  "emphasis:exit"?: WithPosition<mdast.Emphasis>;
+  "footnoteDefinition:exit"?: WithPosition<mdast.FootnoteDefinition>;
+  "footnoteReference:exit"?: WithPosition<mdast.FootnoteReference>;
+  "heading:exit"?: WithPosition<mdast.Heading>;
+  "html:exit"?: WithPosition<mdast.Html>;
+  "image:exit"?: WithPosition<mdast.Image>;
+  "imageReference:exit"?: WithPosition<mdast.ImageReference>;
+  "inlineCode:exit"?: WithPosition<mdast.InlineCode>;
+  "link:exit"?: WithPosition<mdast.Link>;
+  "linkReference:exit"?: WithPosition<mdast.LinkReference>;
+  "list:exit"?: WithPosition<mdast.List>;
+  "listItem:exit"?: WithPosition<mdast.ListItem>;
+  "paragraph:exit"?: WithPosition<mdast.Paragraph>;
+  "strong:exit"?: WithPosition<mdast.Strong>;
+  "table:exit"?: WithPosition<mdast.Table>;
+  "tableCell:exit"?: WithPosition<mdast.TableCell>;
+  "tableRow:exit"?: WithPosition<mdast.TableRow>;
+  "text:exit"?: WithPosition<mdast.Text>;
+  "thematicBreak:exit"?: WithPosition<mdast.ThematicBreak>;
+  "yaml:exit"?: WithPosition<mdast.Yaml>;
+  "root:exit"?: WithPosition<mdast.Root>;
+}>, MarkdownFileServices>;
 //#endregion
 export { MarkdownFileServices, markdownLanguage };
 //# sourceMappingURL=language.d.ts.map

package/lib/language.js

@@ -1,26 +1,39 @@
-import { createMarkdownFile } from "./createMarkdownFile.js";
-import { prepareMarkdownFile } from "./prepareMarkdownFile.js";
+import { parseDirectivesFromMarkdownFile } from "./directives/parseDirectivesFromMarkdownFile.js";
 import { createLanguage } from "@flint.fyi/core";
-import fsSync from "node:fs";
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { gfmFromMarkdown } from "mdast-util-gfm";
+import { gfm } from "micromark-extension-gfm";
 
 //#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);
-			}
+		return { createFile: (data) => {
+			const root = fromMarkdown(data.sourceText, {
+				extensions: [gfm()],
+				mdastExtensions: [gfmFromMarkdown()]
+			});
+			return {
+				...parseDirectivesFromMarkdownFile(root, data.sourceText),
+				about: data,
+				services: { root }
+			};
+		} };
+	},
+	runFileVisitors: (file, options, runtime) => {
+		if (!runtime.visitors) return;
+		const { visitors } = runtime;
+		const visitorServices = {
+			options,
+			...file.services
 		};
+		const visit = (node) => {
+			const key = node.type;
+			visitors[key]?.(node, visitorServices);
+			if ("children" in node && Array.isArray(node.children)) for (const child of node.children) visit(child);
+			visitors[`${key}:exit`]?.(node, visitorServices);
+		};
+		visit(file.services.root);
 	}
 });
 

package/lib/nodes.d.ts

@@ -1,3 +1,4 @@
+import { WithExitKeys } from "@flint.fyi/core";
 import * as mdast from "mdast";
 import { Point, Position } from "unist";
 
@@ -5,6 +6,7 @@ import { Point, Position } from "unist";
 interface MarkdownNodesByName extends RootContentMapWithChildren {
   root: WithPosition<mdast.Root>;
 }
+type MarkdownNodeVisitors = WithExitKeys<MarkdownNodesByName>;
 /**
  * A version of {@link Point} where the `offset` always exists.
  */
@@ -26,5 +28,5 @@ type WithPosition<T> = T & {
   position: PositionWithOffsets;
 };
 //#endregion
-export { MarkdownNodesByName, PointWithOffset, PositionWithOffsets, RootContentMapWithChildren, WithPosition };
+export { MarkdownNodeVisitors, MarkdownNodesByName, PointWithOffset, PositionWithOffsets, RootContentMapWithChildren, WithPosition };
 //# sourceMappingURL=nodes.d.ts.map

package/package.json

@@ -1,52 +1,48 @@
 {
-	"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"
-		}
-	}
-}
+  "name": "@flint.fyi/markdown-language",
+  "version": "0.15.1",
+  "description": "[Experimental] Markdown language for Flint.",
+  "homepage": "https://flint.fyi",
+  "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": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.map"
+  ],
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/unist": "^3.0.3",
+    "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",
+    "@flint.fyi/core": "^0.20.0",
+    "@flint.fyi/utils": "^0.14.0"
+  },
+  "devDependencies": {
+    "tsdown": "0.20.1",
+    "vitest": "4.0.15"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "vitest --typecheck --project markdown-language"
+  }
+}

package/lib/createMarkdownFile.d.ts

@@ -1,8 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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/prepareMarkdownFile.d.ts

@@ -1,10 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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