@xyd-js/content 0.0.0-build

package/packages/md/plugins/output-variables/__fixtures__/1.simple/output.json

@@ -0,0 +1,191 @@
+{
+    "type": "root",
+    "children": [
+        {
+            "type": "heading",
+            "depth": 1,
+            "children": [
+                {
+                    "type": "text",
+                    "value": "Heading 1",
+                    "position": {
+                        "start": {
+                            "line": 1,
+                            "column": 3,
+                            "offset": 2
+                        },
+                        "end": {
+                            "line": 1,
+                            "column": 12,
+                            "offset": 11
+                        }
+                    }
+                }
+            ],
+            "position": {
+                "start": {
+                    "line": 1,
+                    "column": 1,
+                    "offset": 0
+                },
+                "end": {
+                    "line": 1,
+                    "column": 12,
+                    "offset": 11
+                }
+            }
+        },
+        {
+            "type": "outputVars",
+            "name": "example",
+            "attributes": {},
+            "children": [
+                {
+                    "type": "code",
+                    "lang": "bash",
+                    "meta": "npm",
+                    "value": "npm i -g xyd-js",
+                    "position": {
+                        "start": {
+                            "line": 5,
+                            "column": 3,
+                            "offset": 27
+                        },
+                        "end": {
+                            "line": 7,
+                            "column": 6,
+                            "offset": 62
+                        }
+                    }
+                },
+                {
+                    "type": "code",
+                    "lang": "bash",
+                    "meta": "yarn",
+                    "value": "yarn global add xyd-js",
+                    "position": {
+                        "start": {
+                            "line": 9,
+                            "column": 3,
+                            "offset": 66
+                        },
+                        "end": {
+                            "line": 11,
+                            "column": 6,
+                            "offset": 109
+                        }
+                    }
+                },
+                {
+                    "type": "code",
+                    "lang": "bash",
+                    "meta": "pnpm",
+                    "value": "pnpm add -g xyd-js",
+                    "position": {
+                        "start": {
+                            "line": 13,
+                            "column": 3,
+                            "offset": 113
+                        },
+                        "end": {
+                            "line": 15,
+                            "column": 6,
+                            "offset": 152
+                        }
+                    }
+                }
+            ],
+            "position": {
+                "start": {
+                    "line": 4,
+                    "column": 1,
+                    "offset": 14
+                },
+                "end": {
+                    "line": 16,
+                    "column": 4,
+                    "offset": 156
+                }
+            }
+        },
+        {
+            "type": "heading",
+            "depth": 2,
+            "children": [
+                {
+                    "type": "text",
+                    "value": "Heading 2",
+                    "position": {
+                        "start": {
+                            "line": 18,
+                            "column": 4,
+                            "offset": 161
+                        },
+                        "end": {
+                            "line": 18,
+                            "column": 13,
+                            "offset": 170
+                        }
+                    }
+                }
+            ],
+            "position": {
+                "start": {
+                    "line": 18,
+                    "column": 1,
+                    "offset": 158
+                },
+                "end": {
+                    "line": 18,
+                    "column": 13,
+                    "offset": 170
+                }
+            }
+        },
+        {
+            "type": "paragraph",
+            "children": [
+                {
+                    "type": "text",
+                    "value": "Lorem ipsum",
+                    "position": {
+                        "start": {
+                            "line": 20,
+                            "column": 1,
+                            "offset": 172
+                        },
+                        "end": {
+                            "line": 20,
+                            "column": 12,
+                            "offset": 183
+                        }
+                    }
+                }
+            ],
+            "position": {
+                "start": {
+                    "line": 20,
+                    "column": 1,
+                    "offset": 172
+                },
+                "end": {
+                    "line": 20,
+                    "column": 12,
+                    "offset": 183
+                }
+            }
+        }
+    ],
+    "position": {
+        "start": {
+            "line": 1,
+            "column": 1,
+            "offset": 0
+        },
+        "end": {
+            "line": 23,
+            "column": 1,
+            "offset": 186
+        }
+    }
+}

package/packages/md/plugins/output-variables/__fixtures__/2.multiple-vars/input.md

@@ -0,0 +1,21 @@
+<<<example
+  ```bash npm
+  npm i -g xyd-js
+  ```
+
+  ```bash yarn
+  yarn global add xyd-js
+  ```
+
+  ```bash pnpm
+  pnpm add -g xyd-js
+  ```
+<<<
+
+<<<example2
+  ```tsx
+  function() {
+    return <div> Hello World </div>
+  }
+  ```
+<<<

package/packages/md/plugins/output-variables/__fixtures__/2.multiple-vars/output.json

@@ -0,0 +1,127 @@
+{
+    "type": "root",
+    "children": [
+      {
+        "type": "outputVars",
+        "name": "example",
+        "attributes": {},
+        "children": [
+          {
+            "type": "code",
+            "lang": "bash",
+            "meta": "npm",
+            "value": "npm i -g xyd-js",
+            "position": {
+              "start": {
+                "line": 2,
+                "column": 3,
+                "offset": 13
+              },
+              "end": {
+                "line": 4,
+                "column": 6,
+                "offset": 48
+              }
+            }
+          },
+          {
+            "type": "code",
+            "lang": "bash",
+            "meta": "yarn",
+            "value": "yarn global add xyd-js",
+            "position": {
+              "start": {
+                "line": 6,
+                "column": 3,
+                "offset": 52
+              },
+              "end": {
+                "line": 8,
+                "column": 6,
+                "offset": 95
+              }
+            }
+          },
+          {
+            "type": "code",
+            "lang": "bash",
+            "meta": "pnpm",
+            "value": "pnpm add -g xyd-js",
+            "position": {
+              "start": {
+                "line": 10,
+                "column": 3,
+                "offset": 99
+              },
+              "end": {
+                "line": 12,
+                "column": 6,
+                "offset": 138
+              }
+            }
+          }
+        ],
+        "position": {
+          "start": {
+            "line": 1,
+            "column": 1,
+            "offset": 0
+          },
+          "end": {
+            "line": 13,
+            "column": 4,
+            "offset": 142
+          }
+        }
+      },
+      {
+        "type": "outputVars",
+        "name": "example2",
+        "attributes": {},
+        "children": [
+          {
+            "type": "code",
+            "lang": "tsx",
+            "meta": null,
+            "value": "function() {\n  return <div> Hello World </div>\n}",
+            "position": {
+              "start": {
+                "line": 16,
+                "column": 3,
+                "offset": 158
+              },
+              "end": {
+                "line": 20,
+                "column": 6,
+                "offset": 225
+              }
+            }
+          }
+        ],
+        "position": {
+          "start": {
+            "line": 15,
+            "column": 1,
+            "offset": 144
+          },
+          "end": {
+            "line": 21,
+            "column": 4,
+            "offset": 229
+          }
+        }
+      }
+    ],
+    "position": {
+      "start": {
+        "line": 1,
+        "column": 1,
+        "offset": 0
+      },
+      "end": {
+        "line": 22,
+        "column": 1,
+        "offset": 230
+      }
+    }
+  }

package/packages/md/plugins/output-variables/__tests__/index.test.ts

@@ -0,0 +1,28 @@
+import { describe, it } from 'vitest';
+
+import { testFixture } from './testHelpers';
+
+const tests = [
+    {
+        name: "1.simple",
+        description: "A simple example of output variables",
+        input: "1.simple/input.md",
+        output: "1.simple/output.json"
+    },
+    {
+        name: "2.multiple-vars",
+        description: "A example of multiple output variables",
+        input: "2.multiple-vars/input.md",
+        output: "2.multiple-vars/output.json"
+    }
+
+]
+
+describe("outputVars", () => {
+    tests.forEach((test) => {
+        it(`[${test.name}]: ${test.description}`, async () => {
+            await testFixture(test.name);
+        });
+    });
+});
+

package/packages/md/plugins/output-variables/__tests__/testHelpers.ts

@@ -0,0 +1,36 @@
+import path from 'node:path';
+import fs from 'node:fs';
+
+import { remark } from 'remark'
+import { expect } from 'vitest';
+
+import { remarkOutputVars } from '../remarkOutputVars';
+
+const fixturesDir = path.resolve(__dirname, '../__fixtures__');
+
+// Helper function to run a test with a specific fixture
+export async function testFixture(fixtureName: string) {
+    const input = readFixture(`${fixtureName}/input.md`);
+    const expectedOutput = readFixtureOutput(`${fixtureName}/output.json`);
+
+    const result = await processMarkdown(input)
+    expect(result).toEqual(expectedOutput);
+}
+
+// Helper function to read fixture files
+function readFixture(name: string) {
+    const fixturePath = path.join(fixturesDir, name);
+    return fs.readFileSync(fixturePath, "utf8");
+}
+
+// Helper function to read fixture output
+function readFixtureOutput(name: string) {
+    const fixturePath = path.join(fixturesDir, name);
+    return JSON.parse(fs.readFileSync(fixturePath, "utf8"));
+}
+
+function processMarkdown(input: string) {
+    return remark()
+        .use(remarkOutputVars)
+        .parse(input)
+}

package/packages/md/plugins/output-variables/index.ts

@@ -0,0 +1 @@
+export { remarkOutputVars as outputVars } from './remarkOutputVars'

package/packages/md/plugins/output-variables/lib/const.ts

@@ -0,0 +1,4 @@
+import { codes } from 'micromark-util-symbol'
+
+export const PRIMARY_SYMBOL = codes.lessThan
+export const PRIMARY_SYMBOL_STR = '>'