Skip to content

docs: remove prefix and short summary docs #205

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
acoulton merged 2 commits into from
Oct 12, 2025
Merged

docs: remove prefix and short summary docs #205

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3b3b48
docs: remove prefix and short summary docs
carlos-granados Oct 10, 2025
b89d87b
Update shortSummary description
carlos-granados Oct 12, 2025
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 user_guide/command_line_tool/formatting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ The following options are specific to the Pretty formatter:
* ``multiline`` print out PyStrings and TableNodes in full. Boolean, defaults to true.
* ``showOutput`` show the test stdout output as part of the formatter output. Should be one of the
``ShowOutputOption`` enum values, defaults to ``ShowOutputOption::Yes``.
* ``shortSummary`` show a short summary (with just a list of scenarios) or a long summary (with a list of steps).
Copy link
Contributor

@acoulton acoulton Oct 11, 2025

Choose a reason for hiding this comment

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

I wonder if it's clear to a new user what the "summary" is? Maybe something more like:

Suggested change
* ``shortSummary`` show a short summary (with just a list of scenarios) or a long summary (with a list of steps).
* ``shortSummary`` show just a list of failing scenarios at the end of the output. If false, a full summary (which also includes a list of failing steps) will be printed.

Obviously would need to be changed further down as well.

Copy link
Contributor Author

@carlos-granados carlos-granados Oct 12, 2025

Choose a reason for hiding this comment

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

Good suggestion, updated

Defaults to true (short summary)

Progress formatter
^^^^^^^^^^^^^^^^^^
Expand All @@ -125,6 +127,8 @@ The following options are specific to the Progress formatter:
* ``timer`` show time and memory usage at the end of the test run. Boolean, defaults to true.
* ``showOutput`` show the test stdout output as part of the formatter output. Should be one of the
``ShowOutputOption`` enum values, defaults to ``ShowOutputOption::InSummary``.
* ``shortSummary`` show a short summary (with just a list of scenarios) or a long summary (with a list of steps).
Defaults to false (long summary)

Setting format options
^^^^^^^^^^^^^^^^^^^^^^
Expand Down
14 changes: 12 additions & 2 deletions user_guide/configuration/printing_paths.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ need to be different if you are running your code within a Docker container). So
- For PhpStorm: ``phpstorm://open?file={relPath}&line={line}``
- For VS Code: ``vscode://file/{absPath}:{line}``

``Remove Prefix``: This allows you to define a list of prefixes that need to be removed from paths
when printing them. This affects only the visible paths, not the ones used in the editorUrl. This is
useful if your feature or context files are located in some subfolders, for example ``tests/behat/features``
and ``src/behat``. It is not very informative if these folders are always printed when printing paths
and you may prefer to remove them

.. note::

The path style can be different for the visible path and the one used in the editor URL. For example you
Expand All @@ -40,11 +46,15 @@ These options can be set using the ``withPathOptions()`` function of the ``Profi
->withProfile((new Profile('default'))
->withPathOptions(
printAbsolutePaths: true,
editorUrl: 'phpstorm://open?file={relPath}&line={line}'
editorUrl: 'phpstorm://open?file={relPath}&line={line}',
removePrefix: [
'tests/behat/features',
'src/behat',
]
));

They can also be set as command line options (notice that the editor URL will usually need to be quoted):

.. code-block:: bash

behat --print-absolute-paths --editor-url="phpstorm://open?file={relPath}&line={line}"
behat --print-absolute-paths --editor-url="phpstorm://open?file={relPath}&line={line}" --remove-prefix=tests/behat/features,src/behat