This repository was archived by the owner on Aug 7, 2023. It is now read-only.
fix(deps): update remark packages (major) #286
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.
This PR contains the following updates:
11.0.2->14.0.37.0.1->11.0.01.3.2->4.0.12.0.3->5.1.22.1.3->5.1.33.0.3->6.1.3Release Notes
remarkjs/remark (remark)
v14.0.3Compare Source
Misc
https://github.com/remarkjs/remark/issues/11621162
f6bd64eRefactortsconfigs for perf and strictnessbb4c814Add improved docs on what this project isby @BeLi4L in https://github.com/remarkjs/remark/pull/1147
bec44aaUpdatetsconfig.jsonto use node16 module resolutionby @ChristianMurphy in https://github.com/remarkjs/remark/pull/1106
f07f413Addignore-scriptsto.npmrcby @ChristianMurphy in https://github.com/remarkjs/remark/pull/1103
134ece2Update Actionsby @ChristianMurphy in https://github.com/remarkjs/remark/pull/1070
974f893Fix internal types for TS 4.9Plugins
1e488d0Addremark-insto list of pluginsby @talatkuyuk in https://github.com/remarkjs/remark/pull/1129
e456dc5Addremark-flexible-markersto list of pluginsby @talatkuyuk in https://github.com/remarkjs/remark/pull/1126
42114fcAddremark-flexible-paragraphsto list of pluginsby @talatkuyuk in https://github.com/remarkjs/remark/pull/1120
6aa638aAddremark-flexible-containersto list of pluginsby @talatkuyuk in https://github.com/remarkjs/remark/pull/1112
20e7543Addremark-flexible-code-titlesto list of pluginsby @talatkuyuk in https://github.com/remarkjs/remark/pull/1108
32d6948Addremark-cloudinary-docusaurusto list of pluginsby @johnnyreilly in https://github.com/remarkjs/remark/pull/1090
28aa8b9update tests for changes inmdast-util-to-markdown9af1a87Addremark-code-titleto list of pluginsby @kevinzunigacuellar in https://github.com/remarkjs/remark/pull/1076
0d1eb09Add 7 plugins to list of pluginsby @Xunnamius in https://github.com/remarkjs/remark/pull/1064
c7e8171Remove deprecatedremark-jargonby @LunaticMuch in https://github.com/remarkjs/remark/pull/1059
Full Changelog: remarkjs/remark@14.0.2...14.0.3
v14.0.2Compare Source
87c50a5Add improved docsby @wooorm in https://github.com/remarkjs/remark/pull/900
Full Changelog: remarkjs/remark@14.0.1...14.0.2
v14.0.1Compare Source
9026568Add missing types dependencyv14.0.0Compare Source
b7afd25Use ESMChange:
Learn more about ESM in this guide
42d1b21Update dependenciesunified(10.0.0) (see: https://github.com/unifiedjs/unified/releases/tag/10.0.0)vfile(5.0.0) (see: https://github.com/vfile/vfile/releases/tag/5.0.0)Importantly this renames
tovfile.contentsvfile.valuemdast-util-from-markdown(1.0.0) (see: https://github.com/syntax-tree/mdast-util-from-markdown/releases/tag/1.0.0)mdast-util-to-markdown(1.0.0) (see: https://github.com/syntax-tree/mdast-util-to-markdown/releases/tag/1.0.0)bc55caaAdd JSDoc based typesv13.0.0: (micromark)Compare Source
This is a giant change for remark. It replaces the 5+ year old internals with a new low-level parser:
micromark. The old internals have served billions of users well over the years, but markdown has changed over that time. micromark comes with 100% CommonMark (and GFM as an extension) compliance, and (WIP) docs on parsing rules for how to tokenize markdown with a state machine. micromark, and micromark in remark, is a good base for the future.Migration
remark*packages you are using inpackage.jsonremark-gfmPlease compare with those projects if the new behavior is correct or not (CommonMark Dingus, or create a gist for GFM).
Does remark not match those reference parsers? Please open an issue here!
Changes
remark-parse
remark-parsenow defers its work tomicromarkandmdast-util-from-markdown.micromarkis a new, small, complete, and CommonMark compliant low-level markdown parser.from-markdownturns its tokens into the previously (and still) used syntax tree: mdast. Extensions toremark-parsework differently: they’re a two-part act. See for examplemicromark-extension-footnoteandmdast-util-footnote.commonmarkis no longer an option — it’s the defaultgfmis no longer an option — moved toremark-gfmpedanticis no longer an option — this legacy and buggy flavor of markdown is no longer widely usedblocksis no longer an options — it’s no longer suggested to change the internal list of HTML “block” tag namesremark-stringify
remark-stringify now defers its work to
mdast-util-to-markdown. It’s a new and better serializer with powerful features to ensure serialized markdown represents the syntax tree (mdast), no matter what plugins do. Extensions to it work differently: see for examplemdast-util-footnote.optionscommonmarkis no longer an option, it’s the defaultemphasisnow defaults to*bulletnow defaults to*gfmis no longer an option — moved toremark-gfmtableCellPadding— moved toremark-gfmtablePipeAlign— moved toremark-gfmstringLength— moved toremark-gfmpedanticis no longer an option — this legacy and buggy flavor of markdown is no longer widely usedentitiesis no longer an option — with CommonMark there is almost never a need to use character references, as character escapes are preferredquote— you can now prefer single quotes (') over double quotes (") in titlesChanges to output / the tree
All of these are for CommonMark compatibility. They’re all fixes. Most of them are inconsequential to most folks.
[text][id]and images![alt][id]) are no longer present as such in the syntax tree if they don’t have a corresponding definition ([id]: example.com). The reason for this is that CommonMark requires[text *emphasis start][undefined] emphasis end*to be emphasis.<!---->)<mailto:foobarbaz>are now correctly parsed, and the scheme is part of the tree©w/o the semicolon, are no longer recognizedindentfield is no longer available onpositionThanks
Thanks to Salesforce, Gatsby, Vercel, and Netlify, and our other backers for sponsoring the work on micromark!
To support our continued work, back us on OpenCollective!
v12.0.1Compare Source
963292fChangemasterin links63888afUpdate sponsorsv12.0.0Compare Source
2841e47Updateremark-parse(breaking, please see its release section)
1baae5eUpdateremark-stringify(breaking, please see its release section)
6543d08Updateunified(breaking, please see its release section)
remarkjs/remark-frontmatter (remark-frontmatter)
v4.0.1Compare Source
b56dae7Add improved docsby @wooorm in https://github.com/remarkjs/remark-frontmatter/pull/17
Full Changelog: remarkjs/remark-frontmatter@4.0.0...4.0.1
v4.0.0Compare Source
c02f672Use ESM3f125a9Add JSDoc based typesv3.0.0Compare Source
fb1357bUpdate formicromarkinremark@13(breaking, this update will not work for remark lower than v13, see commit for changes)
v2.0.0Compare Source
7824e34Remove dependency(breaking if
Object.assignis not supported in your runtime)65b8410Add types(breaking, potentially, if you or your dependents use typescript and didn’t expect types)
v1.3.3Compare Source
890ec1dRefactor prosebc4a7f8Add notes on securityremarkjs/remark-lint (remark-preset-lint-consistent)
v5.1.2Compare Source
v5.1.1Compare Source
v5.1.0Compare Source
v5.0.1Compare Source
bca9530Addreadme.mdtoremark-lintpackagev5.0.0Compare Source
This is a big one: remark-lint no longer does anything without you telling it to.
The breaking part is
resetandpresets.On the CLI, please start using
remark-preset-lint-consistent,remark-preset-lint-recommended, and/or create and publish your own config!Changes
f5c1227Makeresetthe default6196124Update for changes in [email protected]77709f5Add support for passing severitiesv4.0.0See
[email protected]v3.0.0382bfbaUpdate dependenciesremarkjs/remark-lint (remark-preset-lint-markdown-style-guide)
v5.1.3Compare Source
v5.1.2Compare Source
v5.1.1Compare Source
c5c3832Markno-auto-link-without-protocolas deprecatedv5.1.0Compare Source
v5.0.1Compare Source
bca9530Addreadme.mdtoremark-lintpackagev5.0.0Compare Source
This is a big one: remark-lint no longer does anything without you telling it to.
The breaking part is
resetandpresets.On the CLI, please start using
remark-preset-lint-consistent,remark-preset-lint-recommended, and/or create and publish your own config!Changes
f5c1227Makeresetthe default6196124Update for changes in [email protected]77709f5Add support for passing severitiesv4.0.0See
[email protected]v3.0.0905f47aUpdate dependenciesremarkjs/remark-lint (remark-preset-lint-recommended)
v6.1.3Compare Source
v6.1.2Compare Source
v6.1.1Compare Source
c5c3832Markno-auto-link-without-protocolas deprecatedv6.0.0Compare Source
Hi! 👋
With 6.0.0, rules are no longer in the
remark-lintpackage. In fact, remark lint doesn’t do much, other than controlling messages.Rules are now each in their own package. You don’t have to
npm installand.use()each package though, you can install and use presets instead. If you find yourself installing many rules to update, maybe create a preset too?By giving more power to presets over the remark-lint package itself, I think rules, especially external rules, will prosper!
First off, if “presets” changed, the below diff shows how you can update:
"dependencies": { "remark-cli": "^0.0.0", "remark-lint": "^0.0.0", "remark-preset-lint-consistent": "^0.0.0", // ... }, "remarkConfig": { - "presets": ["lint-consistent"] + "plugins": ["preset-lint-consistent"] }Second, if you used
remark-lintdirectly, you need to change your config as follows."dependencies": { "remark-cli": "^0.0.0", "remark-lint": "^0.0.0", + "remark-lint-unordered-list-marker-style": "^0.0.0", + "remark-lint-list-item-bullet-indent": "^0.0.0", + "remark-lint-no-multiple-toplevel-headings": "^0.0.0", + "remark-lint-maximum-line-length": "^0.0.0", + "remark-lint-maximum-heading-length": "^0.0.0", + "remark-lint-no-tabs": "^0.0.0", // ... }, "remarkConfig": { - "plugins": { - "remark-lint": { - "unordered-list-marker-style": "consistent", - "list-item-bullet-indent": true, - "no-multiple-toplevel-headings": true, - "maximum-line-length": 9000, - "maximum-heading-length": 300, - "no-tabs": true, - // ... - } + "plugins": [ + "remark-lint", + ["remark-lint-unordered-list-marker-style", "consistent"], + "remark-lint-list-item-bullet-indent", + "remark-lint-no-multiple-toplevel-headings", + ["remark-lint-maximum-line-length", 9000], + ["remark-lint-maximum-heading-length", 300], + "remark-lint-no-tabs", + // ... + ]Finally, if you use remark on the API, change your code as follows:
var remark = require('remark'); var lint = require('remark-lint'); +var unorderedListMarkerStyle = require('remark-lint-unordered-list-marker-style'); +var listItemBulletIndent = require('remark-lint-list-item-bullet-indent'); +var noMultipleToplevelHeadings = require('remark-lint-no-multiple-toplevel-headings'); remark() - .use(lint, { - unorderedListMarkerStyle: 'consistent', - listItemBulletIndent: true, - noMultipleToplevelHeadings: true - maximumLineLength: false - }) + .use(lint) + .use(unorderedListMarkerStyle, 'consistent') + .use(listItemBulletIndent) + .use(noMultipleToplevelHeadings) // ...v5.0.0Compare Source
See
[email protected]v4.0.1Compare Source
149a4a1)59ce8b5)v4.0.03edcac8Update dependenciesConfiguration
📅 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.