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

Rename to optimize.ignoreComponentNames in MDX #10884

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Apr 26, 2024

Changes

@delucis suggested to rename the optimize.customComponentNames option to optimize.ignoreComponentNames, which I agree better reflect its usecase. Since this is an advanced option, I assume this shouldn't affect many projects and wouldn't be cumbersome to rename.

Testing

Existing tests should work

Docs

I added a changeset describing the breaking change. The docs for @astrojs/mdx should also be updated, but I'll send a single PR about all the breaking changes later to the docs repo.

Copy link

changeset-bot bot commented Apr 26, 2024

🦋 Changeset detected

Latest commit: 8fc4ee4

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

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Apr 26, 2024
@bluwy bluwy merged commit d03c9a9 into mdx-v3 Apr 26, 2024
13 checks passed
@bluwy bluwy deleted the mdx-ignore-component-names branch April 26, 2024 09:22
@bluwy bluwy mentioned this pull request May 2, 2024
ematipico pushed a commit that referenced this pull request May 8, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
* fix(mdx): convert remark-images-to-component plugin to a rehype plugin (#10697)

* Remove fs read for MDX transform (#10866)

* Tag MDX component for faster checks when rendering (#10864)

* Use unified plugin only for MDX transform (#10869)

* Only traverse children and handle mdxJsxTextElement when optimizing (#10885)

* Rename to `optimize.ignoreComponentNames` in MDX (#10884)

* Allow remark/rehype plugins added after mdx to work (#10877)

* Improve MDX optimize with sibling nodes (#10887)

* Improve types in rehype-optimize-static.ts

* Rename `ignoreComponentNames` to `ignoreElementNames`

I think this better reflects what it's actually doing

* Simplify plain MDX nodes in optimize option (#10934)

* Format code

* Minimize diff changes

* Update .changeset/slimy-cobras-end.md

Co-authored-by: Sarah Rainsberger <[email protected]>

---------

Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants