feat: support eslint-define-config

Shinigami92 commented 5 months ago

Initial checklist

[ ] I read the support docs
[ ] I read the contributing guide
[x] 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

address https://github.com/mdx-js/eslint-mdx/issues/526

The define-config-support.d.ts now somehow needs to be packed to the lib folder and then be made accessible, so users can us it like described in the issue

changeset-bot[bot] commented 5 months ago

⚠️ No Changeset found

Latest commit: f14339a8f54d220114ff81328a39cd60a5dea720

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

github-actions[bot] commented 5 months ago

📊 Package size report `No changes`

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

Unchanged files

| File | Size | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------: | | [`.babelrc`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.babelrc) | `35 B` | | [`.changeset/config.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.changeset/config.json) | `372 B` | | [`.changeset/README.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.changeset/README.md) | `510 B` | | [`.codesandbox/ci.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.codesandbox/ci.json) | `119 B` | | [`.editorconfig`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.editorconfig) | `161 B` | | [`.eslintrc.js`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.eslintrc.js) | `837 B` | | [`.gitattributes`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.gitattributes) | `35 B` | | [`.github/FUNDING.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.github/FUNDING.yml) | `204 B` | | [`.github/workflows/ci.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.github/workflows/ci.yml) | `1.1 kB` | | [`.github/workflows/codeql.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.github/workflows/codeql.yml) | `794 B` | | [`.github/workflows/pkg-size.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.github/workflows/pkg-size.yml) | `699 B` | | [`.github/workflows/release.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.github/workflows/release.yml) | `1.4 kB` | | [`.lintstagedrc.js`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.lintstagedrc.js) | `50 B` | | [`.simple-git-hooks.js`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.simple-git-hooks.js) | `51 B` | | [`.yarn/plugins/plugin-prepare-lifecycle.cjs`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.yarn/plugins/plugin-prepare-lifecycle.cjs) | `202 B` | | [`.yarnrc.yml`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/.yarnrc.yml) | `332 B` | | [`CHANGELOG.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/CHANGELOG.md) | `283 B` | | [`CONTRIBUTING.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/CONTRIBUTING.md) | `931 B` | | [`LICENSE`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/LICENSE) | `1.1 kB` | | [`package.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/package.json) | `3.4 kB` | | [`packages/eslint-mdx/CHANGELOG.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/CHANGELOG.md) | `25.1 kB` | | [`packages/eslint-mdx/package.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/package.json) | `1.1 kB` | | [`packages/eslint-mdx/README.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/README.md) | `11.7 kB` | | [`packages/eslint-mdx/shim.d.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/shim.d.ts) | `1.4 kB` | | [`packages/eslint-mdx/src/helpers.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/helpers.ts) | `4.3 kB` | | [`packages/eslint-mdx/src/index.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/index.ts) | `121 B` | | [`packages/eslint-mdx/src/meta.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/meta.ts) | `87 B` | | [`packages/eslint-mdx/src/parser.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/parser.ts) | `2.5 kB` | | [`packages/eslint-mdx/src/sync.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/sync.ts) | `384 B` | | [`packages/eslint-mdx/src/tokens.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/tokens.ts) | `6.8 kB` | | [`packages/eslint-mdx/src/types.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/types.ts) | `1.5 kB` | | [`packages/eslint-mdx/src/worker.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/src/worker.ts) | `23.3 kB` | | [`packages/eslint-mdx/tsconfig.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-mdx/tsconfig.json) | `131 B` | | [`packages/eslint-plugin-mdx/CHANGELOG.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/CHANGELOG.md) | `27.9 kB` | | [`packages/eslint-plugin-mdx/package.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/package.json) | `1.0 kB` | | [`packages/eslint-plugin-mdx/README.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/README.md) | `11.7 kB` | | [`packages/eslint-plugin-mdx/src/configs/base.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/base.ts) | `305 B` | | [`packages/eslint-plugin-mdx/src/configs/code-blocks.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/code-blocks.ts) | `1.0 kB` | | [`packages/eslint-plugin-mdx/src/configs/flat.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/flat.ts) | `705 B` | | [`packages/eslint-plugin-mdx/src/configs/index.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/index.ts) | `439 B` | | [`packages/eslint-plugin-mdx/src/configs/overrides.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/overrides.ts) | `725 B` | | [`packages/eslint-plugin-mdx/src/configs/recommended.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/configs/recommended.ts) | `2.4 kB` | | [`packages/eslint-plugin-mdx/src/helpers.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/helpers.ts) | `620 B` | | [`packages/eslint-plugin-mdx/src/index.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/index.ts) | `128 B` | | [`packages/eslint-plugin-mdx/src/meta.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/meta.ts) | `87 B` | | [`packages/eslint-plugin-mdx/src/processors/helpers.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/processors/helpers.ts) | `633 B` | | [`packages/eslint-plugin-mdx/src/processors/index.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/processors/index.ts) | `198 B` | | [`packages/eslint-plugin-mdx/src/processors/options.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/processors/options.ts) | `1.8 kB` | | [`packages/eslint-plugin-mdx/src/processors/remark.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/processors/remark.ts) | `1.8 kB` | | [`packages/eslint-plugin-mdx/src/processors/types.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/processors/types.ts) | `241 B` | | [`packages/eslint-plugin-mdx/src/rules/.eslintrc`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/rules/.eslintrc) | `124 B` | | [`packages/eslint-plugin-mdx/src/rules/index.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/rules/index.ts) | `138 B` | | [`packages/eslint-plugin-mdx/src/rules/remark.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/rules/remark.ts) | `3.6 kB` | | [`packages/eslint-plugin-mdx/src/rules/types.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/src/rules/types.ts) | `415 B` | | [`packages/eslint-plugin-mdx/tsconfig.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/packages/eslint-plugin-mdx/tsconfig.json) | `131 B` | | [`patches/eslint+8.56.0.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/eslint+8.56.0.patch) | `555 B` | | [`patches/smartwrap+2.0.2.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/smartwrap+2.0.2.patch) | `461 B` | | [`patches/string-width-cjs+4.2.3.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/string-width-cjs+4.2.3.patch) | `444 B` | | [`patches/tty-table+4.2.3.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/tty-table+4.2.3.patch) | `926 B` | | [`patches/wrap-ansi-cjs+7.0.0.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/wrap-ansi-cjs+7.0.0.patch) | `489 B` | | [`patches/yargs+17.7.2.patch`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/patches/yargs+17.7.2.patch) | `124.6 kB` | | [`README.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/README.md) | `11.7 kB` | | [`test/__snapshots__/fixtures.test.ts.snap`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/__snapshots__/fixtures.test.ts.snap) | `57.5 kB` | | [`test/__snapshots__/flat-config.test.ts.snap`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/__snapshots__/flat-config.test.ts.snap) | `823 B` | | [`test/__snapshots__/parser.test.ts.snap`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/__snapshots__/parser.test.ts.snap) | `1.1 MB` | | [`test/fixtures.test.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures.test.ts) | `2.7 kB` | | [`test/fixtures/287.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/287.mdx) | `204 B` | | [`test/fixtures/292.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/292.mdx) | `191 B` | | [`test/fixtures/334.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/334.mdx) | `70 B` | | [`test/fixtures/336.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/336.mdx) | `178 B` | | [`test/fixtures/367.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/367.mdx) | `87 B` | | [`test/fixtures/371.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/371.mdx) | `75 B` | | [`test/fixtures/380.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/380.mdx) | `11.0 kB` | | [`test/fixtures/391.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/391.mdx) | `62 B` | | [`test/fixtures/429.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/429.mdx) | `52 B` | | [`test/fixtures/435.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/435.mdx) | `134 B` | | [`test/fixtures/437.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/437.mdx) | `32 B` | | [`test/fixtures/445.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/445.mdx) | `188 B` | | [`test/fixtures/450.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/450.mdx) | `418 B` | | [`test/fixtures/488.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/488.mdx) | `78 B` | | [`test/fixtures/acorn.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/acorn.mdx) | `860 B` | | [`test/fixtures/adjacent.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/adjacent.mdx) | `50 B` | | [`test/fixtures/async/.remarkrc`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/async/.remarkrc) | `67 B` | | [`test/fixtures/async/test.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/async/test.md) | `15 B` | | [`test/fixtures/basic.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/basic.mdx) | `405 B` | | [`test/fixtures/basic.tsx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/basic.tsx) | `77 B` | | [`test/fixtures/blank-lines.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/blank-lines.mdx) | `768 B` | | [`test/fixtures/code-blocks.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/code-blocks.md) | `511 B` | | [`test/fixtures/comments.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/comments.mdx) | `162 B` | | [`test/fixtures/details.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/details.mdx) | `881 B` | | [`test/fixtures/dir.mdx/.gitkeep`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/dir.mdx/.gitkeep) | `0 B` | | [`test/fixtures/esm/.remarkrc.mjs`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/esm/.remarkrc.mjs) | `103 B` | | [`test/fixtures/esm/test.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/esm/test.md) | `15 B` | | [`test/fixtures/flat-config/code-blocks.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/flat-config/code-blocks.mdx) | `76 B` | | [`test/fixtures/jsx-in-list.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/jsx-in-list.mdx) | `810 B` | | [`test/fixtures/leading-spaces.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/leading-spaces.mdx) | `42 B` | | [`test/fixtures/markdown.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/markdown.md) | `5 B` | | [`test/fixtures/no-unescaped-entities.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/no-unescaped-entities.mdx) | `99 B` | | [`test/fixtures/no-unused-expressions.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/no-unused-expressions.mdx) | `90 B` | | [`test/fixtures/processor.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/processor.mdx) | `13 B` | | [`test/fixtures/remark.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/remark.md) | `171 B` | | [`test/fixtures/remark.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/remark.mdx) | `169 B` | | [`test/fixtures/style/.remarkrc`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/style/.remarkrc) | `228 B` | | [`test/fixtures/style/nested.md`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/style/nested.md) | `10 B` | | [`test/fixtures/style/plugin1.cjs`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/style/plugin1.cjs) | `26 B` | | [`test/fixtures/style/plugin2.mjs`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/style/plugin2.mjs) | `24 B` | | [`test/fixtures/unicorn.jsx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/unicorn.jsx) | `119 B` | | [`test/fixtures/unicorn.mdx`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/fixtures/unicorn.mdx) | `118 B` | | [`test/flat-config.test.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/flat-config.test.ts) | `1.0 kB` | | [`test/helpers.test.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/helpers.test.ts) | `874 B` | | [`test/helpers.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/helpers.ts) | `548 B` | | [`test/parser.test.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/parser.test.ts) | `4.6 kB` | | [`test/remark.test.ts`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/test/remark.test.ts) | `2.8 kB` | | [`tsconfig.base.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/tsconfig.base.json) | `235 B` | | [`tsconfig.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/tsconfig.json) | `259 B` | | [`tsconfig.lib.json`](https://github.com/Shinigami92/eslint-mdx/blob/issue-526/tsconfig.lib.json) | `195 B` |

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

codesandbox-ci[bot] commented 5 months ago

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.

Shinigami92 commented 5 months ago

@JounQin please have a look and it would be really nice if you take the PR over from here I'm not familiar with this repo, yarn v4 and the project's structure So I don't know how to build that file to the lib folder

codecov-commenter commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (6615813) 100.00% compared to head (f14339a) 100.00%.

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

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #527 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 19 19 Lines 196 196 Branches 33 33 ========================================= Hits 196 196 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JounQin commented 5 months ago

@Shinigami92 OK, I'll finish it.

mdx-js / eslint-mdx