Update remark monorepo (major)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| remark (source) | ^11.0.2 -> ^14.0.0 |
||||
| remark-footnotes | ^1.0.0 -> ^4.0.0 |
Release Notes
remarkjs/remark
v14.0.2
-
87c50a5Add improved docs by @wooorm in https://github.com/remarkjs/remark/pull/900
Full Changelog: https://github.com/remarkjs/remark/compare/14.0.1...14.0.2
v14.0.1
-
9026568Add missing types dependency
v14.0.0
-
b7afd25Use ESM-
Change:
// From CommonJS var remark = require('remark') // To ESM import {remark} from 'remark' // Plugins use default exports: var remarkParse = require('remark-parse') // => import remarkParse from 'remark-parse' var remarkStringify = require('remark-stringify') // => import remarkStringify from 'remark-stringify'
-
-
42d1b21Update dependencies- Update
unified(10.0.0) (see: https://github.com/unifiedjs/unified/releases/tag/10.0.0) - Update
vfile(5.0.0) (see: https://github.com/vfile/vfile/releases/tag/5.0.0) Importantly this renames ~~vfile.contents~~ tovfile.value - Update
mdast-util-from-markdown(1.0.0) (see: https://github.com/syntax-tree/mdast-util-from-markdown/releases/tag/1.0.0) - Update
mdast-util-to-markdown(1.0.0) (see: https://github.com/syntax-tree/mdast-util-to-markdown/releases/tag/1.0.0)
- Update
-
bc55caaAdd JSDoc based types
v13.0.0
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
- Update all the
remark*packages you are using inpackage.json - Did you use GFM (tables and so, used to be the default)? Now add
remark-gfm - Try running it all. If it fails, you are probably using a syntax extension which hasn’t been updated yet, there are issues open on the issue trackers of those plugins already
- Compare the previous output to the new output: anything wrong? See below for the changelog which might cover it. Otherwise, It’s probably because remark is now CommonMark (or GFM) compliant. Please 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-parse now defers its work to micromark and mdast-util-from-markdown. micromark is a new, small, complete, and CommonMark compliant low-level markdown parser. from-markdown turns its tokens into the previously (and still) used syntax tree: mdast. Extensions to remark-parse work differently: they’re a two-part act. See for example micromark-extension-footnote and mdast-util-footnote.
- change:
commonmarkis no longer an option — it’s the default - move:
gfmis no longer an option — moved toremark-gfm - remove:
pedanticis no longer an option — this legacy and buggy flavor of markdown is no longer widely used - remove:
blocksis no longer an options — it’s no longer suggested to change the internal list of HTML “block” tag names
remark-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 example mdast-util-footnote.
options
- change:
commonmarkis no longer an option, it’s the default - change:
emphasisnow defaults to* - change:
bulletnow defaults to* - move:
gfmis no longer an option — moved toremark-gfm - move:
tableCellPadding— moved toremark-gfm - move:
tablePipeAlign— moved toremark-gfm - move:
stringLength— moved toremark-gfm - remove:
pedanticis no longer an option — this legacy and buggy flavor of markdown is no longer widely used - remove:
entitiesis no longer an option — with CommonMark there is almost never a need to use character references, as character escapes are preferred - new:
quote— you can now prefer single quotes (') over double quotes (") in titles
Changes to output / the tree
All of these are for CommonMark compatibility. They’re all fixes. Most of them are inconsequential to most folks.
-
notable: references (as in, links
[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. -
notable: it is no longer possible to use two blank lines between two lists or a list and indented code. CommonMark prohibits it. For a solution, use an empty comment to end lists (
<!---->) - inconsequential: whitespace at the start and end of lines in paragraphs is now ignored
- inconsequential:
<mailto:foobarbaz>are now correctly parsed, and the scheme is part of the tree - inconsequential: indented code can now follow a block quote w/o blank line
- inconsequential: trailing indented blank lines after indented code are no longer part of that code
- inconsequential: character references and escapes are no longer present as separate text nodes
- inconsequential: character references which HTML allows but CommonMark doesn’t, such as
©w/o the semicolon, are no longer recognized - inconsequential: the
indentfield is no longer available onposition - fix: multiline setext headings
- fix: lazy lists
- fix: attention (emphasis, strong)
- fix: tabs
- fix: empty alt on images is now present as an empty string
- …plus a ton of other minor previous differences from CommonMark
Thanks
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.1
v12.0.0
-
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-footnotes
v4.0.1
-
cf5b45eUpdate docs, tests for changes inremark-rehype
v4.0.0
-
6ec8372Use ESM
Learn more about ESM in this guide// From CommonJS var remarkFootnotes = require('remark-footnotes') // To ESM import remarkFootnotes from 'remark-footnotes' -
6249e02Add JSDoc based types -
4c4f827Remove warning for remark 12
v3.0.0
-
0cfeae1Update formicromarkinremark@13(breaking, this update will not work with remark lower than v13, and see commit for other changes)
v2.0.0
-
020aa32Add types (breaking, potentially, if you or your dependents use typescript)
Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), 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.
- [ ] If you want to rebase/retry this PR, click this checkbox.
This PR has been generated by Mend Renovate. View repository job log here.