Skip to content

#582: Fix Markdown importer dropping items after a code block following a title#583

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.

Sign up for GitHub

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

Merged
redcatbear merged 3 commits into from
Sep 5, 2026
+31 −0
Merged

#582: Fix Markdown importer dropping items after a code block following a title #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4134876
#582: Fix Markdown importer dropping items after code block following…
koppor Aug 31, 2026
55d2e9d
#582: Assert a second requirement after the code block
koppor Sep 4, 2026
3761d71
Merge branch 'main' into bugfix/582_code_block_after_section_title
redcatbear Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/changes/changes_4.10.0.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ Each release now includes an SPDX 3 SBOM for the product JAR and a SHA-256 check

* #542: CI and releases now provide an SPDX 3 SBOM.

## Bugfixes

* #582: Fixed the Markdown importer silently dropping all specification items after a fenced code block that directly follows a section title.

## Documentation

* #579: Documented planned deprecations and removals.
1 change: 1 addition & 0 deletions ...rkdown/src/main/java/org/itsallcode/openfasttrace/importer/markdown/MarkdownImporter.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ protected Transition[] configureTransitions()
transition(TITLE , TITLE , MdPattern.UNDERLINE , () -> {} ),
transition(TITLE , TITLE , MdPattern.EMPTY , () -> {} ),
transition(TITLE , START , MdPattern.FORWARD , () -> {forward(); resetTitle();} ),
transition(TITLE , CODE_BLOCK , MdPattern.CODE_BEGIN , this::resetTitle ),
transition(TITLE , START , MdPattern.EVERYTHING , this::resetTitle ),

transition(SPEC_ITEM , SPEC_ITEM , MdPattern.ID , this::beginItem ),
Expand Down
26 changes: 26 additions & 0 deletions .../test/java/org/itsallcode/openfasttrace/importer/markdown/TestMarkdownMarkupImporter.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,32 @@ void testWhenInsideMarkdownCodeBlockThenNoSpecificationItemMustBeDetected(final
emptyIterable());
}

@Test
void testWhenCodeBlockDirectlyFollowsTitleThenFollowingSpecificationItemMustBeDetected()
{
assertImport("code_block_after_title.md", """
## A diagram before any requirement

```mermaid
graph TD
A --> B
```

`req~example~1`

@redcatbearredcatbearSep 4, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding a second requirement for safety here would be good to prove that the next ones are not dropped.

@kopporkopporSep 4, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Added req~example~2 right after — the test now asserts both items are detected.

@redcatbearredcatbearSep 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks. Perfect.


`req~example~2`
""",
contains(
item()
.id(SpecificationItemId.parseId("req~example~1"))
.location("code_block_after_title.md", 8)
.build(),
item()
.id(SpecificationItemId.parseId("req~example~2"))
.location("code_block_after_title.md", 10)
.build()));
}

@ParameterizedTest
@CsvSource(
{
Expand Down
Loading