Update remark (major) #486

renovate · 2023-12-04T02:12:22Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
remark (source)	`^11.0.2` -> `^15.0.0`
remark-footnotes	`^1.0.0` -> `^4.0.0`

Release Notes

remarkjs/remark (remark)

`v15.0.1`

Compare Source

54ee687 Fix typo

Full Changelog: remarkjs/remark@15.0.0...15.0.1

`v15.0.0`

Compare Source

Change

98a2560 Change to require Node.js 16
migrate: update too
a3e6d54 Change to use exports
migrate: don’t use private APIs
943f6ac Update @types/mdast, mdast-util-{from,to}-markdown, unified, etc
migrate: update too
remark-parse: only really changes Buffer -> Uint8Array, so use encodings supported by TextDecoder if you are passing binary data
remark-stringify: bulletOrderedOther is removed, you can remove bulletOrderedOther if you passed it, it’s now the default;
fences is now true by default, if you don’t want indented code, pass fences: false;
listItemIndent is now 'one' by default, you can remove listItemIndent: 'one' if you passed it, or explicitly set it to 'tab' if you want it

Types

bd8c922 Add typed settings

9026568 Add missing types dependency

`v14.0.0`

Compare Source

b7afd25 Use 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'

Learn more about ESM in this guide

42d1b21 Update 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~~ to vfile.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)
bc55caa Add JSDoc based types

`v13.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

Update all the remark* packages you are using in package.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: commonmark is no longer an option — it’s the default
move: gfm is no longer an option — moved to remark-gfm
remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
remove: blocks is 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: commonmark is no longer an option, it’s the default
change: emphasis now defaults to *
change: bullet now defaults to *
move: gfm is no longer an option — moved to remark-gfm
move: tableCellPadding — moved to remark-gfm
move: tablePipeAlign — moved to remark-gfm
move: stringLength — moved to remark-gfm
remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
remove: entities is 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 &copy w/o the semicolon, are no longer recognized
inconsequential: the indent field is no longer available on position
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`

Compare Source

963292f Change master in links
63888af Update sponsors

`v12.0.0`

Compare Source

(see 15.0.0)

remarkjs/remark-footnotes (remark-footnotes)

`v4.0.1`

Compare Source

cf5b45e Update docs, tests for changes in remark-rehype

`v4.0.0`

Compare Source

6ec8372 Use ESM

// From CommonJS
var remarkFootnotes = require('remark-footnotes')

// To ESM
import remarkFootnotes from 'remark-footnotes'

Learn more about ESM in this guide

6249e02 Add JSDoc based types
4c4f827 Remove warning for remark 12

`v3.0.0`

Compare Source

0cfeae1 Update for micromark in remark@13
(breaking, this update will not work with remark lower than v13, and see commit for other changes)

`v2.0.0`

Compare Source

020aa32 Add 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, check this box

This PR has been generated by Mend Renovate. View repository job log here.

renovate bot force-pushed the renovate/major-remark branch from 8bf7eb2 to 675a3bf Compare December 11, 2023 15:37

renovate bot force-pushed the renovate/major-remark branch from 675a3bf to e92a431 Compare February 5, 2024 03:35

renovate bot force-pushed the renovate/major-remark branch 2 times, most recently from 7f5d60d to 7c8fe98 Compare February 19, 2024 03:54

renovate bot force-pushed the renovate/major-remark branch 2 times, most recently from 434a5b6 to aa0ae8d Compare March 18, 2024 03:40

renovate bot force-pushed the renovate/major-remark branch from aa0ae8d to 32b9aaa Compare April 29, 2024 04:05

Update remark

84b7899

renovate bot force-pushed the renovate/major-remark branch from 32b9aaa to 84b7899 Compare May 7, 2024 19:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update remark (major) #486

Update remark (major) #486

renovate bot commented Dec 4, 2023

Update remark (major) #486

Are you sure you want to change the base?

Update remark (major) #486

Conversation

renovate bot commented Dec 4, 2023

Release Notes

Change

Types

Docs

Misc

Plugins

v13.0.0: (micromark)

Migration

Changes

remark-parse

remark-stringify

options

Changes to output / the tree

Thanks

Configuration

`v13.0.0`: (micromark)

`options`