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

Open
koppor wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −0
Open

#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
1 commit
Select commit
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 number Diff line number Diff 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 number Diff line number Diff 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
19 changes: 19 additions & 0 deletions .../test/java/org/itsallcode/openfasttrace/importer/markdown/TestMarkdownMarkupImporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,25 @@ 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`
""",
contains(item()
.id(SpecificationItemId.parseId("req~example~1"))
.location("code_block_after_title.md", 8)
.build()));
}

@ParameterizedTest
@CsvSource(
{
Expand Down