Support for Multiple Levels of Hierarchy in the Tree View

[frederikb]

Is your feature request related to a problem? Please describe.

When working with many feature files in projects that follow a hierarchical directory structure (as recommended in Cucumber's blog on organizing feature files), the current Tree View in Cluecumber becomes difficult to navigate because it does not reflect the structure beyond the feature/scenario grouping, making it more challenging to locate specific functionality or understand the organization of the test suite.

Example of a folder structure:

Describe the solution you'd like

1. Support for Multiple Levels of Hierarchy in the Tree View:

   • Add an option to reflect the directory hierarchy of feature files in the Tree View.
   • Optionally exclude shared base paths (e.g., /features/) via configuration (or automaticallt detect shared base paths).

2. Readable Directory Names:

   • Automatically format directory names into readable headings (using a configurable strategy, similar to DisplayNameGenerator in JUnit 5):
     • Convert snake_case to Snake Case (replace underscores with spaces and capitalize each word).
     • Format camelCase or PascalCase into Camel Case or Pascal Case.
   • Optionally support a configurable replacement map for custom naming.

3. Optional: Markdown Support for Living Documentation:

   • Allow index.md files in the feature file folder structure to act as headings and descriptions:
     • Use the first-level heading (#) from the markdown file as the folder name in the Tree View.
     • Display markdown content as part of the report to provide richer documentation.
   • Caveat: Requires Cluecumber to have access to the actual folders instead of only consuming the reports JSON

Describe alternatives you've considered

• Using separate tooling to build the structured overview of the test suite / living documentation instead of using the Tree View

Additional context

Made up example with some questionable formatting, but should help illustrate my point:

How do you currently address the challenge of organizing and navigating through many scenarios? Would this proposal align with your usage, and is it something you would consider?

[bischoffdev]

Thanks a lot for this detailed description. It sounds like an interesting feature.
Currently, all of our hundreds of features are only in one single hierarchy so we never faced this. But I can see why this makes sense for teams that follow this multi-folder approach.

[frederikb]

Another way to structure the same information would be to keep the flat display of features and scenarios as it is, but optionally to group them by their directories:

This would keep deeply nested hierarchies from potentially breaking the page layout and causing a lot of horizontal scrolling.

[frederikb]

I hope it's ok that I proposed an implementation of this change via PR #370. Happy to continue the discussion there.

[bischoffdev]

At the moment, Cluecumber development is paused due to higher priorities. So it will take some more time for us to look at your proposed PR.