docs: fix broken line numbers #16606

chenxsan · 2022-12-03T09:05:36Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Closes #16042.

Enable templateFormats for @11ty/eleventy-plugin-syntaxhighlight to stop it from processing code block for markdown
Add some markdown-it plugins to generate line numbers, which are based on vitepress's implementation

Before

https://eslint.org/docs/latest/rules/function-paren-newline#when-not-to-use-it

After

https://deploy-preview-16606--docs-eslint.netlify.app/rules/function-paren-newline#when-not-to-use-it

And here's a video where I'm switching tabs between before and after:

eslint-compare.mov

Is there anything you'd like reviewers to focus on?

Note that this is more like a workaround because the upstream won't fix it in near future from what I can tell when
the feature request for showing line numbers has been proposed for almost 4 years now with two old pull requests without any response from the maintainer.

And I believe with this pull request we can just remove @11ty/eleventy-plugin-syntaxhighlight.

netlify · 2022-12-03T09:05:40Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`90c9415`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/639010a5f1150d00088e4e82
😎 Deploy Preview	https://deploy-preview-16606--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

docs/src/assets/scss/syntax-highlighter.scss

Co-authored-by: Strek <ssharishkumar@gmail.com>

kecrily

LGTM

harish-sethuraman

LGTM, Just make sure nothing has broken (I checked quite few pages and it seemed to work fine). This is good to merge 👍🏻

amareshsm

LGTM

nzakas · 2022-12-06T19:50:54Z

docs/mdSyntaxHighlighter.js

@@ -0,0 +1,81 @@
+/** @typedef {import("markdown-it")} MarkdownIt */


This isn't the right location for this file. Can you please move it to src/_plugins and rename to md-syntax-highlighter.js?

Also, did you copy any of this code from somewhere else? If so, we need to include the license information.

Hi Nicholas, as there're some discrepancies between eslint docs site and vitepress, e.g., they use shiki for syntax highlight and author their code in TypeScript, while we use Prismjs and JavaScript, hence I modified the markdown plugins based on their implementation. So yes, I did copy some code from its repository.

LICENSE added.

nzakas

LGTM. Thanks for cleaning that up!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.29.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/eslint/8.29.0/8.30.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.30.0`](https://github.com/eslint/eslint/releases/tag/v8.30.0) [Compare Source](eslint/eslint@v8.29.0...v8.30.0) #### Features - [`075ef2c`](eslint/eslint@075ef2c) feat: add suggestion for no-return-await ([#16637](eslint/eslint#16637)) (Daniel Bartholomae) - [`7190d98`](eslint/eslint@7190d98) feat: update globals ([#16654](eslint/eslint#16654)) (Sébastien Règne) #### Bug Fixes - [`1a327aa`](eslint/eslint@1a327aa) fix: Ensure flat config unignores work consistently like eslintrc ([#16579](eslint/eslint#16579)) (Nicholas C. Zakas) - [`9b8bb72`](eslint/eslint@9b8bb72) fix: autofix recursive functions in no-var ([#16611](eslint/eslint#16611)) (Milos Djermanovic) #### Documentation - [`6a8cd94`](eslint/eslint@6a8cd94) docs: Clarify Discord info in issue template config ([#16663](eslint/eslint#16663)) (Nicholas C. Zakas) - [`ad44344`](eslint/eslint@ad44344) docs: CLI documentation standardization ([#16563](eslint/eslint#16563)) (Ben Perlmutter) - [`293573e`](eslint/eslint@293573e) docs: fix broken line numbers ([#16606](eslint/eslint#16606)) (Sam Chen) - [`fa2c64b`](eslint/eslint@fa2c64b) docs: use relative links for internal links ([#16631](eslint/eslint#16631)) (Percy Ma) - [`75276c9`](eslint/eslint@75276c9) docs: reorder options in no-unused-vars ([#16625](eslint/eslint#16625)) (Milos Djermanovic) - [`7276fe5`](eslint/eslint@7276fe5) docs: Fix anchor in URL ([#16628](eslint/eslint#16628)) (Karl Horky) - [`6bef135`](eslint/eslint@6bef135) docs: don't apply layouts to html formatter example ([#16591](eslint/eslint#16591)) (Tanuj Kanti) - [`dfc7ec1`](eslint/eslint@dfc7ec1) docs: Formatters page updates ([#16566](eslint/eslint#16566)) (Ben Perlmutter) - [`8ba124c`](eslint/eslint@8ba124c) docs: update the `prefer-const` example ([#16607](eslint/eslint#16607)) (Pavel) - [`e6cb05a`](eslint/eslint@e6cb05a) docs: fix css leaking ([#16603](eslint/eslint#16603)) (Sam Chen) #### Chores - [`f2c4737`](eslint/eslint@f2c4737) chore: upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@1](https://github.com/1).4.0 ([#16675](eslint/eslint#16675)) (Milos Djermanovic) - [`ba74253`](eslint/eslint@ba74253) chore: standardize npm script names per [#14827](eslint/eslint#14827) ([#16315](eslint/eslint#16315)) (Patrick McElhaney) - [`0d9af4c`](eslint/eslint@0d9af4c) ci: fix npm v9 problem with `file:` ([#16664](eslint/eslint#16664)) (Milos Djermanovic) - [`90c9219`](eslint/eslint@90c9219) refactor: migrate off deprecated function-style rules in all tests ([#16618](eslint/eslint#16618)) (Bryan Mishkin) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1689 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

docs: fix broken line numbers

a6f0e53

eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Dec 3, 2022

eslint-github-bot bot added the documentation Relates to ESLint's documentation label Dec 3, 2022

chenxsan marked this pull request as ready for review December 3, 2022 09:12

chenxsan requested a review from a team as a code owner December 3, 2022 09:12

chenxsan added 2 commits December 3, 2022 18:39

docs: fix scss styles

9e8d597

docs: fix lint errors

c1210e5

amareshsm added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Dec 3, 2022

harish-sethuraman added the contributor pool label Dec 5, 2022

harish-sethuraman reviewed Dec 5, 2022

View reviewed changes

docs/src/assets/scss/syntax-highlighter.scss Outdated Show resolved Hide resolved

chenxsan and others added 2 commits December 5, 2022 22:26

Update docs/src/assets/scss/syntax-highlighter.scss

e5a478e

Co-authored-by: Strek <ssharishkumar@gmail.com>

docs: fix scss

39c801b

kecrily approved these changes Dec 5, 2022

View reviewed changes

harish-sethuraman approved these changes Dec 5, 2022

View reviewed changes

amareshsm approved these changes Dec 5, 2022

View reviewed changes

nzakas requested changes Dec 6, 2022

View reviewed changes

chenxsan added 3 commits December 7, 2022 08:34

docs: move file and add license

758d37f

add aria-hidden

2dde17d

add license to file header

90c9415

nzakas approved these changes Dec 8, 2022

View reviewed changes

nzakas merged commit 293573e into eslint:main Dec 8, 2022
21 checks passed

chenxsan deleted the bugfix/close-16042 branch December 9, 2022 00:54

amareshsm mentioned this pull request Dec 10, 2022

docs: fix language option styling #16636

Closed

1 task

mdjermanovic mentioned this pull request Dec 16, 2022

formatters examples appear as html-encoded text #16676

Closed

github-actions bot mentioned this pull request May 2, 2023

Upgraded some dependencies - Attempt 2 AurorNZ/report-updated-dependencies#638

Merged

docs: fix broken line numbers #16606

docs: fix broken line numbers #16606

chenxsan commented Dec 3, 2022 •

edited

netlify bot commented Dec 3, 2022 •

edited

kecrily left a comment

harish-sethuraman left a comment •

edited

amareshsm left a comment

nzakas Dec 6, 2022

chenxsan Dec 7, 2022 •

edited

chenxsan Dec 7, 2022 •

edited

nzakas left a comment

		@@ -0,0 +1,81 @@
		/** @typedef {import("markdown-it")} MarkdownIt */

docs: fix broken line numbers #16606

docs: fix broken line numbers #16606

Conversation

chenxsan commented Dec 3, 2022 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Dec 3, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

kecrily left a comment

Choose a reason for hiding this comment

harish-sethuraman left a comment • edited

Choose a reason for hiding this comment

amareshsm left a comment

Choose a reason for hiding this comment

nzakas Dec 6, 2022

Choose a reason for hiding this comment

chenxsan Dec 7, 2022 • edited

Choose a reason for hiding this comment

chenxsan Dec 7, 2022 • edited

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

chenxsan commented Dec 3, 2022 •

edited

netlify bot commented Dec 3, 2022 •

edited

harish-sethuraman left a comment •

edited

chenxsan Dec 7, 2022 •

edited

chenxsan Dec 7, 2022 •

edited