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

fix: incorrect docs due to prettier + mdx v2+ incompatible #499

Merged
merged 2 commits into from Dec 24, 2023
Merged

Conversation

JounQin
Copy link
Member

@JounQin JounQin commented Dec 24, 2023

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

As title

@JounQin JounQin added the 📚 area/docs This affects documentation label Dec 24, 2023
@JounQin JounQin self-assigned this Dec 24, 2023
Copy link

changeset-bot bot commented Dec 24, 2023

🦋 Changeset detected

Latest commit: 0e8b43f

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 Patch
eslint-plugin-mdx Patch

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

Copy link

codesandbox-ci bot commented Dec 24, 2023

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.

@codecov-commenter
Copy link

codecov-commenter commented Dec 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f3dea74) 100.00% compared to head (0e8b43f) 100.00%.

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

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #499   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines          196       196           
  Branches        33        33           
=========================================
  Hits           196       196           

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

Copy link
Contributor

github-actions bot commented Dec 24, 2023

📊 Package size report   No changes

File Before After
Total (Includes all files) 1.5 MB 1.5 MB
Tarball size 173.2 kB 173.2 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 837 B
.gitattributes 35 B
.github/FUNDING.yml 204 B
.github/workflows/ci.yml 862 B
.github/workflows/codeql.yml 836 B
.github/workflows/pkg-size.yml 503 B
.github/workflows/release.yml 1.1 kB
.lintstagedrc.js 50 B
.simple-git-hooks.js 51 B
CHANGELOG.md 283 B
CONTRIBUTING.md 931 B
LICENSE 1.1 kB
package.json 3.0 kB
packages/eslint-mdx/CHANGELOG.md 24.0 kB
packages/eslint-mdx/package.json 1.1 kB
packages/eslint-mdx/README.md 11.7 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.4 kB
packages/eslint-mdx/src/sync.ts 384 B
packages/eslint-mdx/src/tokens.ts 6.8 kB
packages/eslint-mdx/src/types.ts 1.5 kB
packages/eslint-mdx/src/worker.ts 23.2 kB
packages/eslint-mdx/tsconfig.json 131 B
packages/eslint-plugin-mdx/CHANGELOG.md 26.2 kB
packages/eslint-plugin-mdx/package.json 1.0 kB
packages/eslint-plugin-mdx/README.md 11.7 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 2.3 kB
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.8 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.6 kB
packages/eslint-plugin-mdx/src/rules/types.ts 415 B
packages/eslint-plugin-mdx/tsconfig.json 131 B
patches/eslint+8.54.0.patch 555 B
patches/smartwrap+2.0.2.patch 461 B
patches/string-length+4.0.2.patch 398 B
patches/string-width-cjs+4.2.3.patch 444 B
patches/tty-table+4.2.3.patch 926 B
patches/wrap-ansi-cjs+7.0.0.patch 489 B
patches/yargs+17.7.2.patch 124.6 kB
README.md 11.7 kB
test/__snapshots__/fixtures.test.ts.snap 62.6 kB
test/__snapshots__/flat-config.test.ts.snap 823 B
test/__snapshots__/parser.test.ts.snap 1.1 MB
test/fixtures.test.ts 2.6 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/437.mdx 32 B
test/fixtures/445.mdx 188 B
test/fixtures/450.mdx 418 B
test/fixtures/488.mdx 78 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 195 B

🤖 This report was automatically generated by pkg-size-action

@JounQin JounQin merged commit 97ade8f into master Dec 24, 2023
16 checks passed
@JounQin JounQin deleted the fix/docs branch December 24, 2023 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation
Development

Successfully merging this pull request may close these issues.

None yet

2 participants