tools: implement markdown formatting - #40181
Merged
Trott merged 2 commits intoSep 25, 2021
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
|
Although the goal is to eventually document this feature and get it into workflows in general, for right now, I'd prefer to keep it as a feature that only people experienced with the project use. It's easy to get into a situation where the formatter is giving you markdown that the linter will not accept and the resolution is sometimes not obvious. Also, as of this moment, if you remove .mdlinttimestamp and run the formatter, it will format everything and make a ton of changes. When that is no longer the case (probably because those changes will have been submitted to the code base--can't do it automatically though because some changes, such as to README.md, require changes in ncu and other tools), then advertising the formatter more widely may be a good idea. |
Sorry, something went wrong.
aduh95
reviewed
Sep 22, 2021
Comment thread
tools/lint-md/lint-md.src.mjs
Outdated
targos
reviewed
Sep 23, 2021
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
jasnell
approved these changes
Sep 23, 2021
jasnell
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Largely rubber-stamp lgtm
Sorry, something went wrong.
15 tasks
watilde
approved these changes
Sep 24, 2021
17 tasks
Copy link
Copy Markdown
Contributor
Commit Queue failed- Loading data for nodejs/node/pull/40181 ✔ Done loading data for nodejs/node/pull/40181 ----------------------------------- PR info ------------------------------------ Title tools: implement markdown formatting (#40181) Author Rich Trott (@Trott) Branch Trott:md-formatter -> nodejs:master Labels windows, build, meta, tools, author ready, needs-ci Commits 2 - tools: implement markdown formatting - tools: fix lint-md autolinking Committers 1 - Rich Trott PR-URL: https://github.com/nodejs/node/pull/40181 Reviewed-By: James M Snell Reviewed-By: Daijiro Wachi ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/40181 Reviewed-By: James M Snell Reviewed-By: Daijiro Wachi -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last review: ⚠ - tools: implement markdown formatting ⚠ - tools: fix lint-md autolinking ℹ This PR was created on Wed, 22 Sep 2021 20:55:54 GMT ✔ Approvals: 2 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/40181#pullrequestreview-762097873 ✔ - Daijiro Wachi (@watilde): https://github.com/nodejs/node/pull/40181#pullrequestreview-762796964 ✔ Last GitHub Actions successful ℹ Last Full PR CI on 2021-09-23T14:03:41Z: https://ci.nodejs.org/job/node-test-pull-request/40047/ ⚠ Commits were pushed after the last Full PR CI run: ⚠ - tools: implement markdown formatting ⚠ - tools: fix lint-md autolinking - Querying data for job/node-test-pull-request/40047/ ✔ Build data downloaded ✔ Last Jenkins CI successful -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/1273387386 |
Sorry, something went wrong.
Markdown formatter is now available via `mark format-md` (or `vcbuild format-md` on Windows). PR-URL: nodejs#40181 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Update a transitive dependency in lint-md to fix an autolink bug in the formatter that causes a lot of our files (particularly changelogs) to be misformatted when run through the automatic formatter. Refs: syntax-tree/mdast-util-gfm-autolink-literal@7555d45 PR-URL: nodejs#40181 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
This was referenced Sep 26, 2021
22 tasks
targos
pushed a commit
that referenced
this pull request
Oct 4, 2021
Markdown formatter is now available via `mark format-md` (or `vcbuild format-md` on Windows). PR-URL: #40181 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
targos
pushed a commit
that referenced
this pull request
Oct 4, 2021
Update a transitive dependency in lint-md to fix an autolink bug in the formatter that causes a lot of our files (particularly changelogs) to be misformatted when run through the automatic formatter. Refs: syntax-tree/mdast-util-gfm-autolink-literal@7555d45 PR-URL: #40181 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Markdown formatter is now available via mark format-md (orvcbuild format-md on Windows).
This PR depends on #40180 which is the first (large) commit in this PR. To see the relevant part, view the diff for the remaining commits only. The first commit will go away when 40180 lands. (40180 has landed so the paragraph crossed out here is no longer relevant.)