Skip to content

feat: add MarkdownTester for Markdown components - #132

Merged
mcollovati merged 4 commits into
mainfrom
add-markdown-tester
Jul 8, 2026
Merged

feat: add MarkdownTester for Markdown components#132
mcollovati merged 4 commits into
mainfrom
add-markdown-tester

Conversation

@totally-not-ai

@totally-not-ai totally-not-ai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Adds a MarkdownTester wrapping com.vaadin.flow.component.markdown.Markdown so the annotation processor generates a MarkdownLocator along with the findMarkdown() / use(Markdown) entries on GeneratedLocators. The tester is also registered in TesterWrappers to enable the test(Markdown) DSL.

Includes a MarkdownTesterTest and a MarkdownView covering the new tester.

Fixes #131

Notes

  • This PR is intentionally scoped to the MarkdownTester only. A proposed contributing guideline (PRs should not add @since tags; those are added separately before a release to ensure they are correct) will be submitted as a separate PR so it can be reviewed and merged independently. The @since tag briefly added to MarkdownTester has been dropped accordingly.

Adds a MarkdownTester wrapping com.vaadin.flow.component.markdown.Markdown
so the annotation processor generates a MarkdownLocator and the
findMarkdown()/use(Markdown) entries on GeneratedLocators. Also registers
the tester in TesterWrappers for the test(Markdown) DSL.

Fixes #131
@Artur-
Artur- requested a review from mcollovati July 8, 2026 08:53
mcollovati
mcollovati previously approved these changes Jul 8, 2026
* @param <T>
* component type
*/
@Tests(Markdown.class)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need a @since tag, or will we delegate this to the new workflow?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch — added @since 1.1 to the class Javadoc, matching the convention used by the other recently added testers (e.g. DashboardTester and the slider testers) at the current 1.1-SNAPSHOT version.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reversed course here: rather than adding a @since tag, added a contributing guideline (CONTRIBUTING.md) stating that individual PRs should not add @since tags — these are added in a separate pass before a release so the version is correct. Dropped the @since 1.1 tag from MarkdownTester accordingly.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make exactly two commits (tester and CONTRIBUTING.md), so we can merge them separately? Or make a distinct PR for contributing guidelines.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Split the two concerns apart. This PR is now scoped to the MarkdownTester only — I removed CONTRIBUTING.md here — and the @since guideline moved to its own PR (#133) so the two can be reviewed and merged independently. The tester carries no @since tag, in line with that guideline.

mcollovati
mcollovati previously approved these changes Jul 8, 2026
Add @SInCE tags separately before a release to ensure they are correct,
and drop the tag added to MarkdownTester.
@mcollovati
mcollovati enabled auto-merge (squash) July 8, 2026 09:27
@mcollovati
mcollovati disabled auto-merge July 8, 2026 09:37
Keep this PR focused on the MarkdownTester; the contributing guideline
about @SInCE tags will be proposed in a separate PR so it can be
reviewed and merged independently.
@mcollovati
mcollovati enabled auto-merge (squash) July 8, 2026 09:43
@mcollovati
mcollovati merged commit 9a5a088 into main Jul 8, 2026
6 checks passed
@mcollovati
mcollovati deleted the add-markdown-tester branch July 8, 2026 09:45
mcollovati pushed a commit that referenced this pull request Jul 8, 2026
Adds a `CONTRIBUTING.md` documenting that individual PRs should not add
`@since` tags. These are added in a separate pass before a release, once
the target version is known, to ensure they are correct.

Split out from #132 so the tester and the guideline can be reviewed and
merged independently.

Co-authored-by: totally-not-ai[bot] <290682512+totally-not-ai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing findMarkdown()

1 participant