Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update remark (major) #2791

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 18, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
remark-preset-lint-consistent (source) ^5.0.0 -> ^6.0.0 age adoption passing confidence
remark-preset-lint-recommended (source) ^6.0.0 -> ^7.0.0 age adoption passing confidence

Release Notes

remarkjs/remark-lint (remark-preset-lint-consistent)

v6.0.0

Compare Source

Hi! 👋

With 6.0.0, rules are no longer in the remark-lint package. 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 install and .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-lint directly, 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)
  // ...

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.

👻 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.

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@ChristianMurphy ChristianMurphy merged commit 99f4b7c into master Apr 18, 2024
8 checks passed
@ChristianMurphy ChristianMurphy deleted the renovate/major-remark branch April 18, 2024 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant