chore(tests): add some tests for ReadMe custom components#1354
Open
maximilianfalco wants to merge 12 commits intofalco/mdxish-cleanupfrom
Open
chore(tests): add some tests for ReadMe custom components#1354maximilianfalco wants to merge 12 commits intofalco/mdxish-cleanupfrom
maximilianfalco wants to merge 12 commits intofalco/mdxish-cleanupfrom
Conversation
maximilianfalco
changed the title
Contributor
|
I wonder if we break this PR down further so it's easier to read, maybe into 2 parts for different batches of components? |
Contributor
Author
|
@eaglethrost this is already broken down into several parts tbh, this one just has a lot of diffs because im just consolidating and adding missing tests what do you reckon needs to be split |
Contributor
Maybe we can split it like:
I feel like reading 25ish files is quite too big |
Contributor
Author
|
okay I think looking at this again, it should be fine. thankfully most of the file changes are trivial and easy to review. Out of 39, we have
so that brings it to 25 files changed. which is still significant but those changes are just test additions |
eaglethrost
added a commit
that referenced
this pull request
Apr 17, 2026
| 🎫 Resolve ISSUE_ID | | :-----------------: | ## 🎯 What does this PR do? Increased test coverage for the readme components & added testing for both the mdx & mdxish rendering engine. This is to better catch potential regressions from changes, and also ensure mdx & mdxish outputs are consistent with each other. This copies some tests from Falco's old PR in #1354 - Added a test pattern where the same input should be rendered with all the rendering engines, utilising snapshots for some tests - Created a customComponents fixture to help with MDX component tests ## 🧪 QA tips Every new test should pass
rafegoldberg
pushed a commit
that referenced
this pull request
Apr 22, 2026
## Version 14.1.0 ### ⚠ BREAKING CHANGES * **mdxish:** AST nodes - We can't just use safeMode because we still need the inline expressions to be parsed as expression nodes, so there still needs to be an expression parsing ## 🎯 What does this PR do? ### ✨ New & Improved * **mdxish:** remove jsx attribute expression preprocessing ([#1429](#1429)) ([9545472](9545472)), closes [#1426](#1426) ### 🛠 Fixes & Updates * add readme components tests ([#1434](#1434)) ([72ea080](72ea080)), closes [#1354](#1354) * **deps:** bump actions/upload-artifact from 5 to 7 ([#1417](#1417)) ([3ca6d32](3ca6d32)) * **mdxish:** legacy glossary syntax in callout title crashing ([#1441](#1441)) ([9d1b18b](9d1b18b)) <!--SKIP CI-->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This is a follow up of #1353. This PR mainly adds test for existing functions for more robust regression prevention.
🧬 QA & Testing