Skip to content

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 28, 2025

This PR contains the following updates:

Package Change Age Confidence
markdownlint-cli2 0.17.2 -> 0.18.1 age confidence

Release Notes

DavidAnson/markdownlint-cli2 (markdownlint-cli2)

v0.18.1

Compare Source

  • Update dependencies (including markdownlint)

v0.18.0

Compare Source

  • Use user ID in Docker containers for security
  • Update dependencies (including markdownlint)
  • Remove support for end-of-life Node 18

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.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from a team as a code owner August 28, 2025 09:40
@renovate renovate bot added the dependencies Pull requests that update a dependency file label Aug 28, 2025
Copy link

codecov bot commented Aug 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.06%. Comparing base (16c786c) to head (2516d22).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5891   +/-   ##
=======================================
  Coverage   95.06%   95.06%           
=======================================
  Files         307      307           
  Lines        8031     8031           
  Branches     1627     1627           
=======================================
  Hits         7635     7635           
  Misses        396      396           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@renovate renovate bot force-pushed the renovate/markdownlint-cli2-0.x branch from 102282c to 37aa0b3 Compare August 31, 2025 11:16
@renovate renovate bot force-pushed the renovate/markdownlint-cli2-0.x branch from 37aa0b3 to f7b2fcb Compare September 2, 2025 12:41
@trentm
Copy link
Contributor

trentm commented Sep 3, 2025

npm run lint:markdown is failing:

CHANGELOG.md:174:57 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
CHANGELOG.md:177:57 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
CONTRIBUTING.md:87:369 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
doc/upgrade-to-2.x.md:211:296 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
...

because markdownlint-cli2 added a new MD059/descriptive-link-text check (DavidAnson/markdownlint-cli2@ba5646f#diff-1876ef6ac21e1058f5e88387385d548e03695520436667aa019fab3d2bf8b886R1786-R1787):

    "MD059": {
      "description": "MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md",
      "type": [
        "boolean",
        "object"
      ],
      "default": true,
      "properties": {
        "prohibited_texts": {
          "description": "Prohibited link texts",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [
            "click here",
            "here",
            "link",
            "more"
          ]
        }
      },
      "additionalProperties": false
    },

The check doesn't like specific generic words/phrases as the link text. E.g. More info on Widgets can be found [here](https://example.com). is now bad.

@trentm
Copy link
Contributor

trentm commented Sep 3, 2025

The relevant change is the transitive update to [email protected]: https://github.com/DavidAnson/markdownlint/blob/main/CHANGELOG.md#0380

The rule is documented here: https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md

This is for better a11y.

@trentm
Copy link
Contributor

trentm commented Sep 3, 2025

The second concern is that Node.js v18 support has been dropped. This isn't an issue for CI (which uses Node.js v22), but perhaps an annoyance for a developer attempting to use v18. v18 is out of LTS so I don't think we need to maintain lint working for those cases. I'll do this as a hint in case this ever breaks for someone locally:

diff --git a/package.json b/package.json
index 265bf8174..c2e7d4026 100644
--- a/package.json
+++ b/package.json
@@ -26,8 +26,8 @@
     "lint:fix:changed": "lerna run --concurrency 1 --stream lint:fix --since HEAD --exclude-dependents",
     "lint:examples": "eslint --no-error-on-unmatched-pattern ./examples/**/*.js",
     "lint:examples:fix": "eslint --no-error-on-unmatched-pattern ./examples/**/*.js --fix",
-    "lint:markdown": "markdownlint-cli2 $(git ls-files '*.md')",
-    "lint:markdown:fix": "markdownlint-cli2 --fix $(git ls-files '*.md')",
+    "lint:markdown": "markdownlint-cli2 $(git ls-files '*.md')  # requires Node.js >=20",
+    "lint:markdown:fix": "markdownlint-cli2 --fix $(git ls-files '*.md')  # requires Node.js >=20",
     "lint:semconv-deps": "./scripts/lint-semconv-deps.mjs",
     "reset": "lerna clean -y && rm -rf node_modules && npm i && npm run compile && npm run lint:fix",
     "update-ts-configs": "node scripts/update-ts-configs.js",

Copy link
Contributor Author

renovate bot commented Sep 3, 2025

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@trentm
Copy link
Contributor

trentm commented Sep 3, 2025

lint:markdown fails as follows in CI, but not locally:

 > [email protected] lint:markdown
> markdownlint-cli2 $(git ls-files '*.md')  # requires Node.js >=20

.github/ISSUE_TEMPLATE/discussion.md:14:270 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
.github/ISSUE_TEMPLATE/feature_request.md:25:270 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
.github/ISSUE_TEMPLATE/request_for_instrumentation.md:31:270 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]

I've no idea why.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants