chore(cli): redo docs validation so that we are forced to add fern ch…

…eck rules (#4771)

fern/pages/changelogs/cli/2024-09-28.mdx

@@ -0,0 +1,6 @@
+## 0.43.7
+**`(fix):`** The `valid-markdown` rule has been updated to try and parse the markdown file into a 
+valid AST. If the file fails to parse, `fern check` will log an error as well 
+as the path to the markdown. 
+
+

packages/cli/cli/versions.yml

@@ -1,3 +1,12 @@
+- changelogEntry:
+    - summary: |
+        The `valid-markdown` rule has been updated to try and parse the markdown file into a 
+        valid AST. If the file fails to parse, `fern check` will log an error as well 
+        as the path to the markdown. 
+      type: fix
+  irVersion: 53
+  version: 0.43.7
+
 - changelogEntry:
     - summary: |
         The OpenAPI importer now appropriately brings in responses that are under the `text/event-stream`

packages/cli/docs-markdown-utils/src/index.ts

@@ -1,3 +1,4 @@
 export { parseImagePaths, replaceImagePathsAndUrls } from "./parseImagePaths";
 export { replaceReferencedMarkdown } from "./replaceReferencedMarkdown";
 export { replaceReferencedCode } from "./replaceReferencedCode";
+export { parseMarkdownToTree } from "./parseMarkdownToTree";

packages/cli/docs-markdown-utils/src/parseImagePaths.ts

@@ -6,6 +6,7 @@ import { fromMarkdown } from "mdast-util-from-markdown";
 import { mdxFromMarkdown } from "mdast-util-mdx";
 import { mdx } from "micromark-extension-mdx";
 import { visit } from "unist-util-visit";
+import { parseMarkdownToTree } from "./parseMarkdownToTree";
 
 interface AbsolutePathMetadata {
     absolutePathToMdx: AbsoluteFilePath;
@@ -48,10 +49,7 @@ export function parseImagePaths(
 
     visitFrontmatterImages(data, ["image", "og:image", "og:logo", "twitter:image"], mapImage);
 
-    const tree = fromMarkdown(content, {
-        extensions: [mdx()],
-        mdastExtensions: [mdxFromMarkdown()]
-    });
+    const tree = parseMarkdownToTree(content);
 
     let offset = 0;
 

packages/cli/docs-markdown-utils/src/parseMarkdownToTree.ts

@@ -0,0 +1,11 @@
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { Root } from "mdast-util-from-markdown/lib";
+import { mdxFromMarkdown } from "mdast-util-mdx";
+import { mdx } from "micromark-extension-mdx";
+
+export function parseMarkdownToTree(content: string): Root {
+    return fromMarkdown(content, {
+        extensions: [mdx()],
+        mdastExtensions: [mdxFromMarkdown()]
+    });
+}

packages/cli/ete-tests/src/tests/generate/__snapshots__/generate.test.ts.snap

@@ -2,6 +2,6 @@
 
 exports[`fern generate > missing docs page 1`] = `
 "[docs]: Found 1 errors and 0 warnings. Run fern check --warnings to print out the warnings.
-[docs]: docs.yml -> navigation -> 0 -> page
+[docs]: docs.yml -> navigation -> 0 -> path
         Path missing.md does not exist"
 `;