feat!: bump all `unified` ecosystem dependencies, support mdx v3 #486

JounQin · 2023-12-01T15:09:12Z

close #480, close #481

The patches are created due to the package manager issue, see also conventional-changelog/commitlint#3642 (comment)

Updating dependencies.

close #480, close #481

changeset-bot · 2023-12-01T15:09:16Z

🦋 Changeset detected

Latest commit: 289ad71

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
eslint-mdx	Major
eslint-plugin-mdx	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codesandbox-ci · 2023-12-01T15:09:31Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

github-actions · 2023-12-01T15:09:58Z

📊 Package size report `No changes`

File	Before	After
Total _{(Includes all files)}	`1.3 MB`	`1.3 MB`
Tarball size	`131.6 kB`	`131.6 kB`

Unchanged files

File	Size
`.babelrc`	`35 B`
`.changeset/config.json`	`372 B`
`.changeset/README.md`	`510 B`
`.codesandbox/ci.json`	`76 B`
`.editorconfig`	`161 B`
`.eslintrc.js`	`591 B`
`.gitattributes`	`35 B`
`.github/FUNDING.yml`	`204 B`
`.github/workflows/ci.yml`	`941 B`
`.github/workflows/codeql.yml`	`836 B`
`.github/workflows/pkg-size.yml`	`496 B`
`.github/workflows/release.yml`	`914 B`
`.lintstagedrc.js`	`50 B`
`.simple-git-hooks.js`	`51 B`
`CHANGELOG.md`	`283 B`
`CONTRIBUTING.md`	`931 B`
`LICENSE`	`1.1 kB`
`package.json`	`2.5 kB`
`packages/eslint-mdx/CHANGELOG.md`	`22.9 kB`
`packages/eslint-mdx/package.json`	`1.2 kB`
`packages/eslint-mdx/README.md`	`10.4 kB`
`packages/eslint-mdx/shim.d.ts`	`1.4 kB`
`packages/eslint-mdx/src/helpers.ts`	`4.3 kB`
`packages/eslint-mdx/src/index.ts`	`121 B`
`packages/eslint-mdx/src/meta.ts`	`182 B`
`packages/eslint-mdx/src/parser.ts`	`2.3 kB`
`packages/eslint-mdx/src/sync.ts`	`384 B`
`packages/eslint-mdx/src/tokens.ts`	`6.7 kB`
`packages/eslint-mdx/src/types.ts`	`1.0 kB`
`packages/eslint-mdx/src/worker.ts`	`21.0 kB`
`packages/eslint-mdx/tsconfig.json`	`131 B`
`packages/eslint-plugin-mdx/CHANGELOG.md`	`24.4 kB`
`packages/eslint-plugin-mdx/package.json`	`1.0 kB`
`packages/eslint-plugin-mdx/README.md`	`10.4 kB`
`packages/eslint-plugin-mdx/src/configs/base.ts`	`305 B`
`packages/eslint-plugin-mdx/src/configs/code-blocks.ts`	`1.0 kB`
`packages/eslint-plugin-mdx/src/configs/flat.ts`	`705 B`
`packages/eslint-plugin-mdx/src/configs/index.ts`	`439 B`
`packages/eslint-plugin-mdx/src/configs/overrides.ts`	`725 B`
`packages/eslint-plugin-mdx/src/configs/recommended.ts`	`806 B`
`packages/eslint-plugin-mdx/src/helpers.ts`	`620 B`
`packages/eslint-plugin-mdx/src/index.ts`	`128 B`
`packages/eslint-plugin-mdx/src/meta.ts`	`182 B`
`packages/eslint-plugin-mdx/src/processors/helpers.ts`	`633 B`
`packages/eslint-plugin-mdx/src/processors/index.ts`	`198 B`
`packages/eslint-plugin-mdx/src/processors/options.ts`	`1.8 kB`
`packages/eslint-plugin-mdx/src/processors/remark.ts`	`1.9 kB`
`packages/eslint-plugin-mdx/src/processors/types.ts`	`241 B`
`packages/eslint-plugin-mdx/src/rules/.eslintrc`	`124 B`
`packages/eslint-plugin-mdx/src/rules/index.ts`	`138 B`
`packages/eslint-plugin-mdx/src/rules/remark.ts`	`3.5 kB`
`packages/eslint-plugin-mdx/src/rules/types.ts`	`415 B`
`packages/eslint-plugin-mdx/tsconfig.json`	`131 B`
`README.md`	`10.4 kB`
`test/__snapshots__/fixtures.test.ts.snap`	`32.6 kB`
`test/__snapshots__/flat-config.test.ts.snap`	`823 B`
`test/__snapshots__/parser.test.ts.snap`	`1.1 MB`
`test/fixtures.test.ts`	`1.8 kB`
`test/fixtures/287.mdx`	`204 B`
`test/fixtures/292.mdx`	`191 B`
`test/fixtures/334.mdx`	`70 B`
`test/fixtures/336.mdx`	`178 B`
`test/fixtures/367.mdx`	`87 B`
`test/fixtures/371.mdx`	`75 B`
`test/fixtures/380.mdx`	`11.0 kB`
`test/fixtures/391.mdx`	`62 B`
`test/fixtures/429.mdx`	`52 B`
`test/fixtures/435.mdx`	`134 B`
`test/fixtures/445.mdx`	`188 B`
`test/fixtures/450.mdx`	`418 B`
`test/fixtures/acorn.mdx`	`860 B`
`test/fixtures/adjacent.mdx`	`50 B`
`test/fixtures/async/.remarkrc`	`67 B`
`test/fixtures/async/test.md`	`15 B`
`test/fixtures/basic.mdx`	`405 B`
`test/fixtures/basic.tsx`	`77 B`
`test/fixtures/blank-lines.mdx`	`768 B`
`test/fixtures/code-blocks.md`	`511 B`
`test/fixtures/comments.mdx`	`162 B`
`test/fixtures/details.mdx`	`881 B`
`test/fixtures/dir.mdx/.gitkeep`	`0 B`
`test/fixtures/esm/.remarkrc.mjs`	`103 B`
`test/fixtures/esm/test.md`	`15 B`
`test/fixtures/flat-config/code-blocks.mdx`	`76 B`
`test/fixtures/jsx-in-list.mdx`	`810 B`
`test/fixtures/leading-spaces.mdx`	`42 B`
`test/fixtures/markdown.md`	`5 B`
`test/fixtures/no-unescaped-entities.mdx`	`99 B`
`test/fixtures/no-unused-expressions.mdx`	`90 B`
`test/fixtures/processor.mdx`	`13 B`
`test/fixtures/remark.md`	`171 B`
`test/fixtures/remark.mdx`	`169 B`
`test/fixtures/style/.remarkrc`	`228 B`
`test/fixtures/style/nested.md`	`10 B`
`test/fixtures/style/plugin1.cjs`	`26 B`
`test/fixtures/style/plugin2.mjs`	`24 B`
`test/fixtures/unicorn.jsx`	`119 B`
`test/fixtures/unicorn.mdx`	`118 B`
`test/flat-config.test.ts`	`1.0 kB`
`test/helpers.test.ts`	`874 B`
`test/helpers.ts`	`548 B`
`test/parser.test.ts`	`4.0 kB`
`test/remark.test.ts`	`2.8 kB`
`tsconfig.base.json`	`235 B`
`tsconfig.json`	`309 B`
`tsconfig.lib.json`	`180 B`

_{🤖 This report was automatically generated by pkg-size-action}

JounQin · 2023-12-01T15:28:45Z

test/__snapshots__/fixtures.test.ts.snap

@@ -6,62 +6,6 @@ exports[`fixtures lint code blocks should work as expected: code-blocks.md 1`] =
    "column": 1,
    "endColumn": 6,
    "endLine": 3,
-    "fix": {


eslint-plugin-markdown is required to be upgraded first? We're locking unified@^11.0.4 for now. See also eslint/markdown#218

tsconfig.lib.json

JounQin · 2023-12-01T15:30:02Z

.github/workflows/ci.yml

@@ -14,16 +14,15 @@ jobs:
          - ubuntu-latest
          - windows-latest
        node:
-          - 16


https://github.com/mdx-js/eslint-mdx/actions/runs/7061866523/job/19224439257?pr=486#step:5:30

You are free to choose 18, as 16 is EOL.
But, Node 16 should work for all other unified projects. Everything is tested and works on Node 16.

Node 16 still works, I disable testing because the expected errors thrown are different with other versions.

codecov-commenter · 2023-12-01T15:36:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7ca1ffe) 100.00% compared to head (289ad71) 100.00%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #486   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines          188       190    +2     
  Branches        32        33    +1     
=========================================
+ Hits           188       190    +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JounQin · 2023-12-02T01:17:00Z

Good to review? @wooorm @ChristianMurphy

patches/unified-engine+11.1.1.patch

packages/eslint-mdx/src/tokens.ts

ChristianMurphy · 2023-12-02T02:53:54Z

packages/eslint-mdx/package.json

+    "tslib": "^2.6.2",
+    "unified": "^11.0.4",
+    "unified-engine": "^11.1.1",
+    "unist-util-visit": "^5.0.0",
    "uvu": "^0.5.6",


using the latest release of node there's an option to drop uvu in favor of node:test https://nodejs.org/api/test.html
Which is even faster, a stable part of node core, and works well with ESM

Maybe a new PR?

We are actually using uvu/assert only, maybe it can be replaced by devlop. For testing, we're using jest now, and will migrate to vitest later.

patches/eslint+8.54.0.patch

patches/string-length+4.0.2.patch

patches/yargs+17.7.2.patch

tsconfig.lib.json

JounQin · 2023-12-03T04:49:29Z

@wooorm So we'll have to wait remark-lint upgrading first?

wooorm · 2023-12-04T15:41:46Z

This is an independent project, so it could update, right? Like all the other projects?

And, other than TypeScript, things still work? Have you tried if it actually works?

JounQin · 2023-12-04T16:52:44Z

@wooorm remark-lint is not working as expected because the plugins are not upgraded yet.

wooorm · 2023-12-04T17:10:23Z

Can you please clarify what doesn’t work?
In my experience, almost all things do work. Perhaps with a @ts-expect-error.

JounQin · 2023-12-04T17:23:36Z

#486 (comment)

I'm not so sure what is the root cause, remark-lint or eslint-plugin-markdown, but I've been trying to align the unified version used in eslint-plugin-markdown.

wooorm · 2023-12-05T11:00:36Z

You link to a line of code. I don‘t see what the bug is. Could you please tell me how to reproduce this? What is the actual output, and what is the output you want?

JounQin · 2023-12-05T12:29:54Z

@wooorm

The code blocks fix properties are removed unexpectedly.

I think it should be related to https://github.com/eslint/markdown/issues/218 which would be fixed by https://github.com/eslint/markdown/pull/229 I'll use `eslint-plugin-markdown@JounQin/eslint-plugin-markdown#feat/bump` to test my fixing PR.

OK, I tried, and it does not work.

wooorm · 2023-12-05T14:47:02Z

I don’t know how to help you.
remark-lint doesn’t generate fix properties.
I don’t see that test case using remark-lint.

JounQin · 2023-12-05T14:51:38Z

@wooorm

mdx/remark ESLint rule is using remark processor inside to lint markdown syntaxes.

eslint-mdx/packages/eslint-plugin-mdx/src/rules/remark.ts

Line 53 in 7ca1ffe

const { messages, content: fixedText } = performSyncWork({

eslint-mdx/packages/eslint-mdx/src/worker.ts

Line 222 in 7ca1ffe

await processor.process(file)

I think we can merge as-is, and just wait remark-lint plugins upgrade later.

wooorm · 2023-12-05T15:29:19Z

But why not the other way around? What is the error? It should work.

But, feel free to wait though, maybe say 2 weeks? I don’t have much time to work on oss right now

JounQin · 2023-12-05T15:34:23Z

But why not the other way around? What is the error? It should work.

unified in remark-lint are old but I'm using resolutions to force using the latest unified packages for all dependencies, I think it's the root cause.

I'm going to merge this PR after upgrading unified-engine to remove related patch file.

jaswrks and others added 4 commits December 1, 2023 20:40

chore: update package.json

2a9353d

Updating dependencies.

chore: update package.json

474ddcb

Updating dependencies.

Update { Configuration } import in worker.ts

2d17526

feat!: bump all unified ecosystem dependencies, support mdx v3

80846ee

close #480, close #481

JounQin added breaking :boom: Breaking Change 📦 area/deps This affects dependencies labels Dec 1, 2023

JounQin requested review from wooorm, ChristianMurphy and a team December 1, 2023 15:09

JounQin self-assigned this Dec 1, 2023

JounQin force-pushed the master branch from 4bc3c4c to 7ca1ffe Compare December 1, 2023 15:10

JounQin added 2 commits December 1, 2023 23:20

test: fix unit test cases

be9830f

chore!: require node >= 18

c36fe91

JounQin commented Dec 1, 2023

View reviewed changes

tsconfig.lib.json Show resolved Hide resolved

JounQin commented Dec 1, 2023

View reviewed changes

ci: use node 18 for codesandbox

16de633

JounQin added 3 commits December 1, 2023 23:38

Create spicy-bikes-sparkle.md

db0a4d9

Create swift-cycles-mix.md

0a823ab

ci: the alias should be lts/* instead of --lts

88932f1

JounQin force-pushed the feat/mdx_v3 branch from e38b339 to 88932f1 Compare December 1, 2023 20:57

JounQin commented Dec 2, 2023

View reviewed changes

patches/unified-engine+11.1.1.patch Outdated Show resolved Hide resolved

JounQin commented Dec 2, 2023

View reviewed changes

packages/eslint-mdx/src/tokens.ts Outdated Show resolved Hide resolved

packages/eslint-mdx/src/tokens.ts Outdated Show resolved Hide resolved

JounQin added 2 commits December 2, 2023 09:25

Update packages/eslint-mdx/src/tokens.ts

1cd00be

Update packages/eslint-mdx/src/tokens.ts

23da599

ChristianMurphy reviewed Dec 2, 2023

View reviewed changes

wooorm approved these changes Dec 4, 2023

View reviewed changes

ChristianMurphy approved these changes Dec 4, 2023

View reviewed changes

chore: use JounQin/eslint-plugin-markdown#feat/bump temporarily

96f0c78

JounQin force-pushed the feat/mdx_v3 branch from a77f3fe to 96f0c78 Compare December 5, 2023 13:26

chore: bump unified-engine

289ad71

JounQin changed the title ~~feat!: bump all unified ecosystem dependencies, support mdx v3~~ feat!: bump all unified ecosystem dependencies, support mdx v3 Dec 5, 2023

JounQin merged commit 508e7ce into master Dec 5, 2023
16 checks passed

JounQin deleted the feat/mdx_v3 branch December 5, 2023 15:54

github-actions bot mentioned this pull request Dec 5, 2023

chore: release package(s) #487

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: bump all `unified` ecosystem dependencies, support mdx v3 #486

feat!: bump all `unified` ecosystem dependencies, support mdx v3 #486

JounQin commented Dec 1, 2023 •

edited

Loading

changeset-bot bot commented Dec 1, 2023 •

edited

Loading

codesandbox-ci bot commented Dec 1, 2023 •

edited

Loading

github-actions bot commented Dec 1, 2023 •

edited

Loading

JounQin Dec 1, 2023 •

edited

Loading

JounQin Dec 1, 2023

wooorm Dec 4, 2023

JounQin Dec 4, 2023

codecov-commenter commented Dec 1, 2023 •

edited

Loading

JounQin commented Dec 2, 2023

ChristianMurphy Dec 2, 2023

JounQin Dec 2, 2023

JounQin Dec 5, 2023

JounQin commented Dec 3, 2023

wooorm commented Dec 4, 2023

JounQin commented Dec 4, 2023

wooorm commented Dec 4, 2023 •

edited

Loading

JounQin commented Dec 4, 2023

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023 •

edited

Loading

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023 •

edited

Loading

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023

feat!: bump all unified ecosystem dependencies, support mdx v3 #486

feat!: bump all unified ecosystem dependencies, support mdx v3 #486

Conversation

JounQin commented Dec 1, 2023 • edited Loading

changeset-bot bot commented Dec 1, 2023 • edited Loading

🦋 Changeset detected

codesandbox-ci bot commented Dec 1, 2023 • edited Loading

github-actions bot commented Dec 1, 2023 • edited Loading

📊 Package size report No changes

JounQin Dec 1, 2023 • edited Loading

Choose a reason for hiding this comment

JounQin Dec 1, 2023

Choose a reason for hiding this comment

wooorm Dec 4, 2023

Choose a reason for hiding this comment

JounQin Dec 4, 2023

Choose a reason for hiding this comment

codecov-commenter commented Dec 1, 2023 • edited Loading

Codecov Report

JounQin commented Dec 2, 2023

ChristianMurphy Dec 2, 2023

Choose a reason for hiding this comment

JounQin Dec 2, 2023

Choose a reason for hiding this comment

JounQin Dec 5, 2023

Choose a reason for hiding this comment

JounQin commented Dec 3, 2023

wooorm commented Dec 4, 2023

JounQin commented Dec 4, 2023

wooorm commented Dec 4, 2023 • edited Loading

JounQin commented Dec 4, 2023

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023 • edited Loading

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023 • edited Loading

wooorm commented Dec 5, 2023

JounQin commented Dec 5, 2023

feat!: bump all `unified` ecosystem dependencies, support mdx v3 #486

feat!: bump all `unified` ecosystem dependencies, support mdx v3 #486

JounQin commented Dec 1, 2023 •

edited

Loading

changeset-bot bot commented Dec 1, 2023 •

edited

Loading

codesandbox-ci bot commented Dec 1, 2023 •

edited

Loading

github-actions bot commented Dec 1, 2023 •

edited

Loading

📊 Package size report `No changes`

JounQin Dec 1, 2023 •

edited

Loading

codecov-commenter commented Dec 1, 2023 •

edited

Loading

wooorm commented Dec 4, 2023 •

edited

Loading

JounQin commented Dec 5, 2023 •

edited

Loading

JounQin commented Dec 5, 2023 •

edited

Loading