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

DMartens · 2024-03-27T17:36:52Z

Fixes #245.
I researched common language codes for javascript and markdown which are not the same as the file extension.
There may be additional ones.
The current tests had test cases for the language codes javascript and node already, so I adjusted them and added a case to make sure the mapping from code block language to file extension is done after the code block language normalization.
This may be a breaking change as additional code blocks may be linted.

nzakas

Thanks for putting this together. I agree, this looks like a breaking change, so adding the label.

It actually looks like this change might have broken the lint task, can you take a look at that?

Otherwise, just a few suggestions throughout.

nzakas · 2024-03-29T21:00:07Z

tests/lib/processor.js

@@ -115,7 +115,7 @@ describe("processor", () => {
                "```js",
                "backticks",
                "```",
-                "~~~javascript",
+                "~~~js",


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

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.

tests/lib/processor.js

DMartens · 2024-03-30T10:55:53Z

The lint task was failing as one of the mappings also enabled linting the nested code blocks nested in markdown.
As I thought all the detected lint errors are irrelevant for demonstrating the plugin, I added them to the existing rule ignores.

DMartens · 2024-04-08T16:13:06Z

I removed the code block language mapping from node to js as mentioned in the issue.
Should I add documentation for this case such as setting parserOptions: { sourceType: 'commonjs' }?

nzakas · 2024-04-08T21:34:36Z

I think at this point we don't need to do anything to cater to CommonJS, specifically. I'm not sure what node is meant to indicate in Markdown anyway.

nzakas · 2024-04-08T21:36:27Z

The lint task was failing as one of the mappings also enabled linting the nested code blocks nested in markdown. As I thought all the detected lint errors are irrelevant for demonstrating the plugin, I added them to the existing rule ignores.

Can you explain this a bit more? I'm not quite sure I follow what happened here. On HEAD linting passes as-is, so I don't just want to disable rules without understanding what changed.

DMartens · 2024-04-08T22:45:27Z

One of the added mappings from code block language was from markdown to md.
This is also the case in the README.md section "What gets linted").. As such the processor is called recursively which was not the case before (just forgot to run the linter on all files).
I ignored the rules such as the console.log (no-console) or function without jsdoc (jsdoc/require-jsdoc) in the nested code blocks are for what I think are demonstration purposes.
The same reason as why no-var for markdown code block was disabled before this PR.

nzakas

Thanks for the explanation. This looks good to me now.

nzakas

Sorry, one last thing: can you please update the README to explain how this works? (There's already a section about how filenames are determined, so expanding on that would be great.)

README.md

Co-authored-by: Nicholas C. Zakas <[email protected]>

nzakas

LGTM. Thanks! Just leaving open to see if other wants to review before merging.

fasttime

Just a note about the docs, otherwise LGTM.

README.md

Co-authored-by: Francesco Trotta <[email protected]>

fasttime

LGTM, thanks!

##### [v5.1.0](https://github.com/eslint/eslint-plugin-markdown/blob/HEAD/CHANGELOG.md#510-2024-07-05) ##### Features - add name to flat configs ([#256](eslint/markdown#256)) ([001d51e](eslint/markdown@001d51e)) ##### [v5.0.0](https://github.com/eslint/eslint-plugin-markdown/blob/HEAD/CHANGELOG.md#500-2024-05-01) ##### ⚠ BREAKING CHANGES - map known code block languages to respective file extensions ([#246](eslint/markdown#246)) ##### Features - map known code block languages to respective file extensions ([#246](eslint/markdown#246)) ([096cff4](eslint/markdown@096cff4)) ##### Bug Fixes - check upper bounds of message line numbers for code blocks ([#247](eslint/markdown#247)) ([00adccb](eslint/markdown@00adccb)) ##### Chores - run tests in Node.js 22, with ESLint 9 ([#250](eslint/markdown#250)) ([085e6d5](eslint/markdown@085e6d5)) - switch to eslint v9, eslint-config-eslint v10 ([#251](eslint/markdown#251)) ([a76cdf5](eslint/markdown@a76cdf5))

feat: map known code block languages to respective file extensions

e40891f

eslint-github-bot bot added the feature label Mar 27, 2024

nzakas added the breaking label Mar 29, 2024

nzakas requested changes Mar 29, 2024

View reviewed changes

nzakas added accepted contributor pool labels Mar 29, 2024

DMartens added 2 commits March 30, 2024 11:38

chore: add missing verb in test case description

df4ef23

chore: resolve README lint errors

ccbcc7f

fix: remove mapping from code block language node to javascript

a9552ad

nzakas previously approved these changes Apr 10, 2024

View reviewed changes

nzakas changed the title ~~feat: map known code block languages to respective file extensions~~ feat!: map known code block languages to respective file extensions Apr 10, 2024

nzakas reviewed Apr 10, 2024

View reviewed changes

docs: explain code block language mapping

a7d2783

DMartens dismissed nzakas’s stale review via a7d2783 April 12, 2024 14:46

nzakas reviewed Apr 12, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

docs: make language mappings more explicit

af81ab2

Co-authored-by: Nicholas C. Zakas <[email protected]>

nzakas previously approved these changes Apr 15, 2024

View reviewed changes

fasttime reviewed Apr 28, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

DMartens dismissed nzakas’s stale review via 27b9e28 April 28, 2024 22:02

docs: use backticks instead of code blocks

27b9e28

Co-authored-by: Francesco Trotta <[email protected]>

fasttime approved these changes Apr 29, 2024

View reviewed changes

fasttime merged commit 096cff4 into eslint:main Apr 29, 2024
10 checks passed

github-actions bot mentioned this pull request Apr 29, 2024

chore: release 5.0.0 #248

Merged

DMartens deleted the code-block-language-to-file-extension-mapping branch April 29, 2024 06:37

github-actions bot mentioned this pull request Jul 16, 2024

chore: release 6.0.0 🚀 #261

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

DMartens commented Mar 27, 2024

nzakas left a comment

nzakas Mar 29, 2024

DMartens Mar 30, 2024

DMartens commented Mar 30, 2024

DMartens commented Apr 8, 2024

nzakas commented Apr 8, 2024

nzakas commented Apr 8, 2024

DMartens commented Apr 8, 2024

nzakas left a comment

nzakas left a comment

nzakas left a comment

fasttime left a comment

fasttime left a comment

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

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

Conversation

DMartens commented Mar 27, 2024

nzakas left a comment

Choose a reason for hiding this comment

nzakas Mar 29, 2024

Choose a reason for hiding this comment

DMartens Mar 30, 2024

Choose a reason for hiding this comment

DMartens commented Mar 30, 2024

DMartens commented Apr 8, 2024

nzakas commented Apr 8, 2024

nzakas commented Apr 8, 2024

DMartens commented Apr 8, 2024

nzakas left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

fasttime left a comment

Choose a reason for hiding this comment

fasttime left a comment

Choose a reason for hiding this comment