Settings¶

Configure the BerryCrush plugin to match your workflow and project needs.

Accessing Settings¶

Mac: IntelliJ IDEA → Settings (or Cmd+,)
Windows/Linux: File → Settings (or Ctrl+Alt+S)
Navigate to Languages & Frameworks → BerryCrush

General Settings¶

OpenAPI Detection¶

Configure how the plugin finds OpenAPI files:

Setting	Description	Default
Auto-detect	Search standard locations	Enabled
Search parent directories	Look in parent folders	Enabled
Max depth	How many levels up to search	5

Custom OpenAPI Paths¶

Add explicit paths to OpenAPI files:

src/main/resources/openapi/api.yaml
api/swagger.json

Supports glob patterns:

**/openapi/*.yaml
src/**/api.*.json

Editor Settings¶

Syntax Highlighting¶

Customize colors at Settings → Editor → Color Scheme → BerryCrush:

Element	Description
Keyword	Given, When, Then, And, But
Fragment Name	Fragment definition names
Operation Reference	`^operationId` references
Variable	`{{variable}}` placeholders
Comment	`#` comments
String	Quoted text
Number	Numeric values
Table Delimiter	Pipe characters in tables

Fonts¶

BerryCrush files use editor font settings:

Settings → Editor → Font

Line Numbers¶

Toggle line numbers in Settings → Editor → General → Appearance

Code Style¶

Indentation¶

Settings → Editor → Code Style → BerryCrush

Setting	Default
Tab size	2
Indent size	2
Continuation indent	4
Use tabs	No

Tables¶

Setting	Default
Align pipe characters	Yes
Pad cell content	Yes
Trim whitespace	Yes

Inspection Settings¶

Configure Inspections¶

Settings → Editor → Inspections → BerryCrush

Available inspections:

Inspection	Default	Severity
Missing fragment reference	Enabled	Error
Unknown OpenAPI operation	Enabled	Warning
Undefined custom step	Disabled	Weak Warning
Undefined assertion	Disabled	Weak Warning

Scope¶

Apply inspections to specific scopes: - All Files: Check everywhere - Project Files: Exclude libraries - Custom Scope: Define your own

Live Templates¶

Built-in Templates¶

Type abbreviation and press Tab:

Abbreviation	Expansion
`sc`	Scenario template
`fr`	Fragment template
`fe`	Feature template
`gi`	Given step
`wh`	When step
`th`	Then step
`ta`	Data table
`in`	Include directive

Custom Templates¶

Create your own at Settings → Editor → Live Templates → BerryCrush:

Click + → Live Template
Set abbreviation and description
Enter template text with variables
Set applicable context to "BerryCrush"

Example template:

scenario: $NAME$
  given $PRECONDITION$
    call ^$OPERATION$
  then verify response
    assert status $STATUS$
$END$

File Templates¶

Create New Templates¶

Settings → Editor → File and Code Templates

Default .scenario template:

scenario: ${SCENARIO_NAME}
  given base URL is set
    baseUrl = "${BASE_URL}"
  when I call the operation
    call ^${OPERATION}
  then verify response
    assert status 200

Default .fragment template:

fragment: ${NAME}
  given ${STEP}
    # TODO: add implementation

Project Settings¶

Per-Project Configuration¶

Create .berrycrush.yaml in project root:

# OpenAPI configuration
openapi:
  paths:
    - src/main/resources/openapi/*.yaml
  auto-detect: true

# Default values
defaults:
  base-url: http://localhost:8080

# Feature flags
features:
  strict-mode: false
  validate-schemas: true

Share settings with team via version control:

Create .idea/berrycrush.xml with settings
Commit to repository
Team members get same configuration

IDE Settings¶

Memory Allocation¶

For large projects, increase memory:

Help → Edit Custom VM Options

-Xmx4096m
-Xms1024m

Index Settings¶

Exclude directories from indexing if not needed:

Settings → Project Structure → Modules → Excluded

Test Runner Configuration¶

For Gradle-based projects, configure IntelliJ to use its built-in test runner instead of delegating to Gradle for optimal BerryCrush test experience.

Note

This configuration is only needed for Gradle projects. Maven projects typically use IntelliJ's built-in test runner by default and should work without changes.

Why This Matters (Gradle Projects)¶

BerryCrush tests use file:// location hints to enable navigation from the test tree directly to .scenario files. This navigation only works when using IntelliJ's built-in test runner because:

The BerryCrush plugin registers a custom TestLocator that handles file:// URLs
When Gradle runs tests, IntelliJ's test locator extensions are bypassed
Gradle has its own test output processing that doesn't support our navigation

Configure Test Runner¶

Open Settings (or Preferences on Mac)
Navigate to Build, Execution, Deployment → Build Tools → Gradle
Find the Run tests using: dropdown
Change from Gradle to IntelliJ IDEA

Test Runner Setting

Features Enabled¶

With IntelliJ test runner configured:

Feature	Description
Scenario navigation	Double-click test tree items to navigate to `.scenario` files
BerryCrush configuration	Gutter icons create BerryCrush configs with proper navigation
Scenario filtering	Run individual scenarios with `-DberryCrush.scenarioName` VM options
Feature filtering	Run all scenarios in a feature with `-DberryCrush.featureName`

Running from Scenario Files¶

When using IntelliJ test runner, you can:

Click the play icon next to a scenario: or feature: keyword
Select a test class from the dropdown (if multiple exist)
The test runs with automatic scenario filtering

The generated run configuration includes VM options:

-DberryCrush.scenarioFile="filename.scenario"
-DberryCrush.scenarioName="Scenario Name"

Export/Import Settings¶

Export¶

File → Manage IDE Settings → Export Settings
Select "BerryCrush" settings
Save to file

Import¶

File → Manage IDE Settings → Import Settings
Select the exported file
Choose "BerryCrush" settings
Restart IDE if prompted

Troubleshooting¶

Settings Not Applied¶

Check correct scope (project vs global)
Restart IDE
Invalidate caches

Missing Options¶

Verify plugin is installed and enabled
Check plugin version compatibility
Update plugin to latest version

Reset to Defaults¶

Go to specific settings section
Click Reset or ⟲ icon
Confirm reset