Skip to content

feat: add support for Markdown Front Matter parsing #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 23, 2025
Merged

feat: add support for Markdown Front Matter parsing #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
688fc25
feat: add support for Markdown Front Matter parsing
lumirlumir Apr 19, 2025
3451587
wip: rename placeholder
lumirlumir Apr 19, 2025
207c871
Merge branch 'main' into feat-support-markdown-frontmatter-parsing
lumirlumir Apr 22, 2025
ff89eb0
wip: pass dummy values to `language.parse()`
lumirlumir Apr 22, 2025
67cd6d2
Merge branch 'feat-support-markdown-frontmatter-parsing' of https://g…
lumirlumir Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 108 additions & 13 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"@eslint/css": "^0.2.0",
"@eslint/js": "^9.9.0",
"@eslint/json": "^0.4.1",
"@eslint/markdown": "^6.1.1",
"@eslint/markdown": "^6.4.0",
"@lezer/highlight": "^1.2.1",
"@radix-ui/react-accordion": "^1.2.0",
"@radix-ui/react-dialog": "^1.1.1",
Expand Down
43 changes: 31 additions & 12 deletions src/components/options.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { useExplorer } from "@/hooks/use-explorer";
import {
jsonModes,
markdownModes,
markdownFrontmatters,
languages,
parsers,
sourceTypes,
Expand All @@ -24,6 +25,7 @@ import type {
JsonMode,
Language,
MarkdownMode,
MarkdownFrontmatter,
SourceType,
Version,
} from "@/hooks/use-explorer";
Expand All @@ -50,19 +52,36 @@ const JSONPanel: React.FC = () => {
const MarkdownPanel: React.FC = () => {
const explorer = useExplorer();
const { markdownOptions, setMarkdownOptions } = explorer;
const { markdownMode } = markdownOptions;
const { markdownMode, markdownFrontmatter } = markdownOptions;
return (
<LabeledSelect
id="markdownMode"
label="Mode"
value={markdownMode}
onValueChange={(value: string) => {
const markdownMode = value as MarkdownMode;
setMarkdownOptions({ ...markdownOptions, markdownMode });
}}
items={markdownModes}
placeholder="Mode"
/>
<>
<LabeledSelect
id="markdownMode"
label="Mode"
value={markdownMode}
onValueChange={(value: string) => {
const markdownMode = value as MarkdownMode;
setMarkdownOptions({ ...markdownOptions, markdownMode });
}}
items={markdownModes}
placeholder="Mode"
/>

<LabeledSelect
id="markdownFrontmatter"
label="Front Matter"
value={markdownFrontmatter}
onValueChange={(value: string) => {
const markdownFrontmatter = value as MarkdownFrontmatter;
setMarkdownOptions({
...markdownOptions,
markdownFrontmatter,
});
}}
items={markdownFrontmatters}
placeholder="Front Matter"
/>
</>
);
};

Expand Down
23 changes: 19 additions & 4 deletions src/hooks/use-ast.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,37 @@ export function useAST() {
case "json": {
const { jsonMode } = jsonOptions;
const language = json.languages[jsonMode];
astParseResult = language.parse({ body: code.json });
astParseResult = language.parse({
body: code.json,
path: "",
physicalPath: "",
bom: false,
});
break;
}

case "markdown": {
const { markdownMode } = markdownOptions;
const { markdownMode, markdownFrontmatter } = markdownOptions;
const language = markdown.languages[markdownMode];
astParseResult = language.parse({ body: code.markdown });
astParseResult = language.parse(
{ body: code.markdown, path: "", physicalPath: "", bom: false },
{
languageOptions: {
frontmatter:
markdownFrontmatter === "off"
? false
: markdownFrontmatter,
},
},
);
break;
}

case "css": {
const { cssMode, tolerant } = cssOptions;
const language = css.languages[cssMode];
astParseResult = language.parse(
{ body: code.css },
{ body: code.css, path: "", physicalPath: "", bom: false },
{ languageOptions: { tolerant } },
);
break;
Expand Down
2 changes: 2 additions & 0 deletions src/hooks/use-explorer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export type Version = Exclude<Options["ecmaVersion"], undefined>;
export type Language = "javascript" | "json" | "markdown" | "css";
export type JsonMode = "json" | "jsonc" | "json5";
export type MarkdownMode = "commonmark" | "gfm";
export type MarkdownFrontmatter = "off" | "yaml" | "toml";
export type CssMode = "css";

export type Code = {
Expand All @@ -41,6 +42,7 @@ export type JsonOptions = {

export type MarkdownOptions = {
markdownMode: MarkdownMode;
markdownFrontmatter: MarkdownFrontmatter;
};

export type CssOptions = {
Expand Down
16 changes: 16 additions & 0 deletions src/lib/const.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,21 @@ export const markdownModes = [
},
];

export const markdownFrontmatters = [
{
value: "off",
label: "Off",
},
{
value: "yaml",
label: "YAML",
},
{
value: "toml",
label: "TOML",
},
];

export const cssModes = [
{
value: "css",
Expand Down Expand Up @@ -381,6 +396,7 @@ export const defaultJsonOptions: JsonOptions = {

export const defaultMarkdownOptions: MarkdownOptions = {
markdownMode: "commonmark",
markdownFrontmatter: "off",
};

export const defaultCssOptions: CssOptions = {
Expand Down