Skip to content
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

Jump to bottom

feat!: map known code block languages to respective file extensions #246

Merged
merged 7 commits into from Apr 29, 2024
Merged

feat!: map known code block languages to respective file extensions #246

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e40891f
feat: map known code block languages to respective file extensions
DMartens Mar 27, 2024
df4ef23
chore: add missing verb in test case description
DMartens Mar 30, 2024
ccbcc7f
chore: resolve README lint errors
DMartens Mar 30, 2024
a9552ad
fix: remove mapping from code block language node to javascript
DMartens Apr 8, 2024
a7d2783
docs: explain code block language mapping
DMartens Apr 12, 2024
af81ab2
docs: make language mappings more explicit
DMartens Apr 13, 2024
27b9e28
docs: use backticks instead of code blocks
DMartens Apr 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion eslint.config.js
View file
Open in desktop
Expand Up @@ -41,7 +41,13 @@ module.exports = [
},
rules: {
"lines-around-comment": "off",
"n/no-missing-import": "off"
"n/no-missing-import": "off",
"no-var": "off",
"padding-line-between-statements": "off",
"no-console": "off",
"no-alert": "off",
"eslint-comments/require-description": "off",
"jsdoc/require-jsdoc": "off"
}
}
];
28 changes: 20 additions & 8 deletions lib/processor.js
View file
Open in desktop
Expand Up @@ -235,6 +235,13 @@ function getBlockRangeMap(text, node, comments) {
return rangeMap;
}

const languageToFileExtension = {
javascript: "js",
ecmascript: "js",
typescript: "ts",
markdown: "md"
};

/**
* Extracts lintable code blocks from Markdown text.
* @param {string} text The text of the file.
Expand Down Expand Up @@ -295,14 +302,19 @@ function preprocess(text, filename) {
}
});

return blocks.map((block, index) => ({
filename: `${index}.${block.lang.trim().split(" ")[0]}`,
text: [
...block.comments,
block.value,
""
].join("\n")
}));
return blocks.map((block, index) => {
const [language] = block.lang.trim().split(" ");
const fileExtension = Object.hasOwn(languageToFileExtension, language) ? languageToFileExtension[language] : language;

return {
filename: `${index}.${fileExtension}`,
text: [
...block.comments,
block.value,
""
].join("\n")
};
});
}

/**
Expand Down
22 changes: 17 additions & 5 deletions tests/lib/processor.js
View file
Open in desktop
Expand Up @@ -115,7 +115,7 @@ describe("processor", () => {
"```js",
"backticks",
"```",
"~~~javascript",
"~~~js",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would make sense to leave this as "javascript" to ensure it gets translated into .js?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are already the preexisting test cases "should find code fences with javascript info string" and "should find code fences with node info string" which test the mapping. As such I changed it in the other test cases.

"tildes",
"~~~"
].join("\n");
Expand All @@ -124,7 +124,7 @@ describe("processor", () => {
assert.strictEqual(blocks.length, 2);
assert.strictEqual(blocks[0].filename, "0.js");
assert.strictEqual(blocks[0].text, "backticks\n");
assert.strictEqual(blocks[1].filename, "1.javascript");
assert.strictEqual(blocks[1].filename, "1.js");
assert.strictEqual(blocks[1].text, "tildes\n");
});

Expand Down Expand Up @@ -255,7 +255,7 @@ describe("processor", () => {
const blocks = processor.preprocess(code);

assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0].filename, "0.javascript");
assert.strictEqual(blocks[0].filename, "0.js");
});

it("should find code fences with node info string", () => {
Expand Down Expand Up @@ -330,6 +330,18 @@ describe("processor", () => {
assert.strictEqual(blocks[0].filename, "0.js");
});

it("should translate the language to its file extension with leading whitespace and trailing characters", () => {
const code = [
"``` javascript CUSTOM",
"var answer = 6 * 7;",
"```"
].join("\n");
const blocks = processor.preprocess(code);

assert.strictEqual(blocks.length, 1);
assert.strictEqual(blocks[0].filename, "0.js");
});

it("should find code fences not surrounded by blank lines", () => {
const code = [
"<!-- eslint-disable -->",
Expand Down Expand Up @@ -408,7 +420,7 @@ describe("processor", () => {
"var answer = 6 * 7;",
"```",
"",
"```javascript",
"```js",
DMartens marked this conversation as resolved.
Show resolved Hide resolved
"console.log(answer);",
"```",
"",
Expand All @@ -419,7 +431,7 @@ describe("processor", () => {
assert.strictEqual(blocks.length, 2);
assert.strictEqual(blocks[0].filename, "0.js");
assert.strictEqual(blocks[0].text, "var answer = 6 * 7;\n");
assert.strictEqual(blocks[1].filename, "1.javascript");
assert.strictEqual(blocks[1].filename, "1.js");
assert.strictEqual(blocks[1].text, "console.log(answer);\n");
});

Expand Down