Add test for commonmark spec (#18428)

package.json

@@ -136,6 +136,7 @@
     "browserslist-to-esbuild": "2.1.1",
     "buffer": "6.0.3",
     "c8": "10.1.3",
+    "commonmark.json": "0.31.0",
     "cross-env": "10.1.0",
     "cspell": "9.3.2",
     "enquirer": "2.4.1",

scripts/clean-markdown-legacy-spec.js

@@ -0,0 +1,19 @@
+import fs from "node:fs/promises";
+import { commonmark } from "commonmark.json";
+
+const existing = new Set(commonmark.map(({ markdown }) => markdown.trim()));
+const DIRECTORY = new URL(
+  "../tests/format/markdown/legacy-spec/",
+  import.meta.url,
+);
+
+for (const file of await fs.readdir(DIRECTORY, { withFileTypes: true })) {
+  if (!file.isFile()) {
+    continue;
+  }
+  const fileUrl = new URL(file.name, DIRECTORY);
+  const content = await fs.readFile(fileUrl, "utf8");
+  if (existing.has(content.trim())) {
+    await fs.rm(new URL(file.name, DIRECTORY));
+  }
+}

scripts/format-test-lint.js

@@ -10,7 +10,7 @@ const FORMAT_TEST_DIRECTORY = path.join(PROJECT_ROOT, "tests/format/");
 const TEST_SCRIPT_FILE_NAME = "format.test.js";
 const SNAPSHOTS_DIRECTORY_NAME = "__snapshots__";
 const IGNORED = new Set([
-  path.join(FORMAT_TEST_DIRECTORY, "markdown/spec/remark-bug"),
+  path.join(FORMAT_TEST_DIRECTORY, "markdown/spec-legacy/remark-bug"),
 ]);
 
 async function* checkDirectory(directory) {

tests/format/markdown/commonmark-test-suite/format.test.js

@@ -0,0 +1,38 @@
+import { commonmark as commonmarkTestSuite } from "commonmark.json";
+
+const BUGS = new Set([
+  "example-11.md",
+  "example-43.md",
+  "example-47.md",
+  "example-77.md",
+  "example-146.md",
+  "example-196.md",
+  "example-273.md",
+  "example-274.md",
+  "example-349.md",
+  "example-417.md",
+  "example-438.md",
+  "example-493.md",
+]);
+
+runFormatTest(
+  {
+    importMeta: import.meta,
+    snippets: commonmarkTestSuite
+      .map(({ section, markdown: input }, index) => {
+        const filename = `example-${index + 1}.md`;
+        if (BUGS.has(filename)) {
+          return;
+        }
+
+        return {
+          name: `example-${index + 1}.md (${section})`,
+          filename,
+          code: input,
+        };
+      })
+      .filter(Boolean),
+  },
+  ["markdown"],
+  { proseWrap: "always" },
+);

tests/format/markdown/spec/commonmark-0.30-example-328.md

@@ -1 +0,0 @@
-`foo`

tests/format/markdown/spec/commonmark-0.30-example-329.md

@@ -1 +0,0 @@
-`` foo ` bar ``

tests/format/markdown/spec/commonmark-0.30-example-330.md

@@ -1 +0,0 @@
-` `` `

tests/format/markdown/spec/commonmark-0.30-example-331.md

@@ -1 +0,0 @@
-`  ``  `

tests/format/markdown/spec/commonmark-0.30-example-332.md

@@ -1 +0,0 @@
-` a`

tests/format/markdown/spec/commonmark-0.30-example-333.md

@@ -1 +0,0 @@
-` b `

tests/format/markdown/spec/commonmark-0.30-example-335.md

@@ -1,5 +0,0 @@
-``
-foo
-bar  
-baz
-``

tests/format/markdown/spec/commonmark-0.30-example-336.md

@@ -1,3 +0,0 @@
-``
-foo 
-``

tests/format/markdown/spec/commonmark-0.30-example-337.md

@@ -1,2 +0,0 @@
-`foo   bar 
-baz`

tests/format/markdown/spec/example-1.md

@@ -1 +0,0 @@
-	foo	baz		bim

tests/format/markdown/spec/example-10.md

@@ -1,2 +0,0 @@
-- `one
-- two`

tests/format/markdown/spec/example-100.md

@@ -1,5 +0,0 @@
-   ```
-   aaa
-    aaa
-  aaa
-   ```

tests/format/markdown/spec/example-101.md

@@ -1,3 +0,0 @@
-    ```
-    aaa
-    ```

tests/format/markdown/spec/example-102.md

@@ -1,3 +0,0 @@
-```
-aaa
-  ```

tests/format/markdown/spec/example-103.md

@@ -1,3 +0,0 @@
-   ```
-aaa
-  ```

tests/format/markdown/spec/example-104.md

@@ -1,3 +0,0 @@
-```
-aaa
-    ```

tests/format/markdown/spec/example-105.md

@@ -1,2 +0,0 @@
-``` ```
-aaa

tests/format/markdown/spec/example-106.md

@@ -1,3 +0,0 @@
-~~~~~~
-aaa
-~~~ ~~

tests/format/markdown/spec/example-107.md

@@ -1,5 +0,0 @@
-foo
-```
-bar
-```
-baz

tests/format/markdown/spec/example-108.md

@@ -1,6 +0,0 @@
-foo
----
-~~~
-bar
-~~~
-# baz

tests/format/markdown/spec/example-109.md

@@ -1,5 +0,0 @@
-```ruby
-def foo(x)
-  return 3
-end
-```

tests/format/markdown/spec/example-110.md

@@ -1,5 +0,0 @@
-~~~~    ruby startline=3 $%@#$
-def foo(x)
-  return 3
-end
-~~~~~~~

tests/format/markdown/spec/example-111.md

@@ -1,2 +0,0 @@
-````;
-````

tests/format/markdown/spec/example-112.md

@@ -1,2 +0,0 @@
-``` aa ```
-foo

tests/format/markdown/spec/example-113.md

@@ -1,3 +0,0 @@
-```
-``` aaa
-```

tests/format/markdown/spec/example-114.md

@@ -1,9 +0,0 @@
-<table>
-  <tr>
-    <td>
-           hi
-    </td>
-  </tr>
-</table>
-
-okay.

tests/format/markdown/spec/example-115.md

@@ -1,3 +0,0 @@
- <div>
-  *hello*
-         <foo><a>

tests/format/markdown/spec/example-116.md

@@ -1,2 +0,0 @@
-</div>
-*foo*

tests/format/markdown/spec/example-117.md

@@ -1,5 +0,0 @@
-<DIV CLASS="foo">
-
-*Markdown*
-
-</DIV>

tests/format/markdown/spec/example-118.md

@@ -1,3 +0,0 @@
-<div id="foo"
-  class="bar">
-</div>

tests/format/markdown/spec/example-119.md

@@ -1,3 +0,0 @@
-<div id="foo" class="bar
-  baz">
-</div>

tests/format/markdown/spec/example-12.md

@@ -1 +0,0 @@
-+++