CONTRIBUTING.md

Spock Contribution Guide

Note

This contribution guide is still work-in-progress.

Useful Commands

Tip

All commands are also available as IntelliJ run configurations in the .run directory.

Run All Tests

./gradlew allTests --quiet --stacktrace

Generate Documentation

./gradlew :docs:dokkaGenerate --stacktrace

Important

Do not commit the docs/history yourself; It'll be generated automatically.

A link to the documentation link will be provided in the console, in the form of localhost:PORT/spock/docs/current/index.html, usually on port 63342.

Run JVM Example

./gradlew :example:jvmRun --quiet --stacktrace

Run Native Example

Note

Replace Platform below with your operating system; for example, LinuxX64.

Debug

./gradlew :example:runDebugExecutablePlatform --quiet --stacktrace

Release

./gradlew :example:runReleaseExecutablePlatform --quiet --stacktrace

WasmJS

Development

./gradlew :example:wasmJsBrowserDevelopmentRun --quiet --stacktrace

Production

./gradlew :example:wasmJsBrowserDevelopmentRun --quiet --stacktrace