chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.3 #135

dependabot · 2025-01-06T05:26:21Z

Changes included (from @JoyceZhu):

Manually convert all import/export styles from CommonJS to ESM
Various filename changes required
Update README to use ESM syntax/examples
package.json changes for ESM
eslint config changes to respect that ESM imports need to reference the file extension in the path without further work
change to lodash-es since the original lodash library is CommonJS-only
change markdownlint-cli2 calls to new async implementations
Updating .nvmrc since I was already here
can't directly import JSON files -- convert those to manual file reads
CLI parameter + Jest config changes to get Jest to also accept ESM

Bumps markdownlint from 0.36.1 to 0.37.3.

Changelog

Sourced from markdownlint's changelog.

0.37.3

Tweak package.json dependencies to work with pnpm

0.37.2

Add subpath imports for overriding default bundler behavior

Improve MD032

0.37.1

Add support for "browser" condition (as used by webpack)

0.37.0

Convert module to ECMAScript (breaking change)

https://nodejs.org/docs/latest/api/esm.html

https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Convert module to named exports (breaking change)

Commits

74b1c19 Update to version 0.37.3.
ef70472 Make micromark-core-commonmark a direct dependency to satisfy strict dependen...
795eac2 Add CI job that verifies tests pass when using pnpm (vs. npm).
df33933 Update export test to avoid "ExperimentalWarning: Importing JSON modules is a...
8e5f699 Bump webpack-cli from 6.0.0 to 6.0.1
92eb425 Bump eslint-plugin-n from 17.15.0 to 17.15.1
1587927 Bump webpack-cli from 5.1.4 to 6.0.0
a1081ec Add "bundler" and "subpath" to dictionary.txt.
5fad452 Update to version 0.37.2.
baf4944 Add subpath imports "markdownlint-imports-browser" and "markdownlint-imports-...
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [markdownlint](https://github.com/DavidAnson/markdownlint) from 0.36.1 to 0.37.3. - [Changelog](https://github.com/DavidAnson/markdownlint/blob/main/CHANGELOG.md) - [Commits](DavidAnson/markdownlint@v0.36.1...v0.37.3) --- updated-dependencies: - dependency-name: markdownlint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

JoyceZhu · 2025-01-10T23:49:46Z

index.js

+  return foo;
+}
+
+// export default githubMarkdownLint;


can't seem to export destructures in ESM, static vs dynamic?

.markdownlint-cli2.mjs

JoyceZhu · 2025-01-10T23:50:26Z

index.js

@@ -1,19 +1,20 @@
-const _ = require("lodash");
+import _ from "lodash-es";


regular lodash is synchronous

JoyceZhu · 2025-01-10T23:50:40Z

package.json

  "directories": {
    "test": "test"
  },
  "scripts": {
    "publish": "npm publish --access public --@github:registry=https://registry.npmjs.org",
-    "test": "npm run lint && jest",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",


jest needs this to enable ESM

JoyceZhu · 2025-01-10T23:50:54Z

package.json

-    "markdownlint": "^0.36.1",
-    "markdownlint-cli2": "^0.16.0"
+    "markdownlint": "^0.37.3",
+    "markdownlint-cli2": "^0.17.0"


cli2 previous version seemed incompatible w/new markdownlint

test/usage.test.js

JoyceZhu · 2025-01-10T23:51:33Z

test/utils/run-test.js

@@ -1,6 +1,6 @@
-const markdownlint = require("markdownlint");
+import { lint } from "markdownlint/async";


needs new function now

lindseywild · 2025-01-13T16:04:07Z

@JoyceZhu should I remove this from the FR queue until you're ready for a review? Or is there anything I can do to assist?

dependabot · 2025-01-20T05:15:04Z

A newer version of markdownlint exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

lindseywild

Nice job! I didn't see anything glaring, and old files seemed to be migrated properly from what I can tell!

khiga8

Looking good! Thank you for your persistence on this!

I just had a few questions :)

khiga8 · 2025-01-21T19:24:16Z

test/accessibility-rules.test.js

+    "no-generic-link-text": true,
+    "ul-style": {
+      style: "asterisk",
+    },
    default: false,


Does default: false turn off all the rules by default-enabled rules?
I'm wondering why we need to explicitly set individual rules to false if default: false.

khiga8 · 2025-01-21T19:27:59Z

.markdownlint-cli2.mjs

@@ -0,0 +1,15 @@
+import { init } from "./index.js";
+
+const configOptions = await init({


I was about to recommend pointing of our projects to this branch to make sure things run as expected with this big change/new setup, but it seems like this basically acts like a test? Would it be worth testing this change out in one of our larger repos that uses this project by pointing to this branch?

Yeah, my understanding after reading for awhile is that we only have this file/use markdownlint-cli2 so we can run our own linting setup against the files in this repo (meta-testing, I guess).

khiga8

Nice work 💟

dependabot bot requested a review from a team as a code owner January 6, 2025 05:26

dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Jan 6, 2025

dependabot bot requested a review from accessibility-bot January 6, 2025 05:26

dependabot bot mentioned this pull request Jan 6, 2025

chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.2 #132

Closed

dependabot bot assigned JoyceZhu Jan 6, 2025

JoyceZhu added 2 commits January 10, 2025 06:51

Progress converting from CommonJS -> ESM

62e3669

progress

a18dbdf

JoyceZhu reviewed Jan 10, 2025

View reviewed changes

.markdownlint-cli2.mjs Show resolved Hide resolved

JoyceZhu reviewed Jan 10, 2025

View reviewed changes

index.js

@@ -1,19 +1,20 @@

const _ = require("lodash");

import _ from "lodash-es";

Copy link

Contributor

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

regular lodash is synchronous

JoyceZhu reviewed Jan 10, 2025

View reviewed changes

test/usage.test.js Show resolved Hide resolved

JoyceZhu reviewed Jan 10, 2025

View reviewed changes

JoyceZhu added 9 commits January 16, 2025 19:04

version update

354ceaa

progress?...

84aebbc

Fix missing trailing .js and following tests

671c049

Merge branch 'main' into dependabot/npm_and_yarn/markdownlint-0.37.3

a03d501

Fix npm run test

239b15a

Test fixes, begin to clean up

db5cd52

re-add space

d6d4f78

Update README with ESM examples

3bd1c70

remove outdated WIP comment

7c5aef4

lindseywild approved these changes Jan 21, 2025

View reviewed changes

khiga8 reviewed Jan 21, 2025

View reviewed changes

Fix test

3a2ce49

khiga8 approved these changes Jan 22, 2025

View reviewed changes

JoyceZhu added 2 commits January 22, 2025 15:37

Merge branch 'main' into dependabot/npm_and_yarn/markdownlint-0.37.3

d86cd37

Update to version 0.2.0

3ae5b70

JoyceZhu force-pushed the dependabot/npm_and_yarn/markdownlint-0.37.3 branch from 021ee10 to 3ae5b70 Compare January 22, 2025 21:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.3 #135

chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.3 #135

dependabot bot commented on behalf of github Jan 6, 2025 •

edited by JoyceZhu

Loading

JoyceZhu Jan 10, 2025

JoyceZhu Jan 10, 2025

JoyceZhu Jan 10, 2025

JoyceZhu Jan 10, 2025

JoyceZhu Jan 10, 2025

lindseywild commented Jan 13, 2025 •

edited

Loading

dependabot bot commented on behalf of github Jan 20, 2025

lindseywild left a comment

khiga8 left a comment

khiga8 Jan 21, 2025

khiga8 Jan 21, 2025 •

edited

Loading

JoyceZhu Jan 21, 2025

khiga8 left a comment

		@@ -1,19 +1,20 @@
		const _ = require("lodash");
		import _ from "lodash-es";

		@@ -1,6 +1,6 @@
		const markdownlint = require("markdownlint");
		import { lint } from "markdownlint/async";

		@@ -0,0 +1,15 @@
		import { init } from "./index.js";

		const configOptions = await init({

chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.3 #135

Are you sure you want to change the base?

chore(deps-dev): bump markdownlint from 0.36.1 to 0.37.3 #135

Conversation

dependabot bot commented on behalf of github Jan 6, 2025 • edited by JoyceZhu Loading

0.37.3

0.37.2

0.37.1

0.37.0

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

JoyceZhu Jan 10, 2025

Choose a reason for hiding this comment

lindseywild commented Jan 13, 2025 • edited Loading

dependabot bot commented on behalf of github Jan 20, 2025

lindseywild left a comment

Choose a reason for hiding this comment

khiga8 left a comment

Choose a reason for hiding this comment

khiga8 Jan 21, 2025

Choose a reason for hiding this comment

khiga8 Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

JoyceZhu Jan 21, 2025

Choose a reason for hiding this comment

khiga8 left a comment

Choose a reason for hiding this comment

dependabot bot commented on behalf of github Jan 6, 2025 •

edited by JoyceZhu

Loading

lindseywild commented Jan 13, 2025 •

edited

Loading

khiga8 Jan 21, 2025 •

edited

Loading