Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 2.75 KB
Raw

Contribution guide (draft)

Dependencies (macOS)

  • install a JDK into the path specified in .snyk.env.darwin. Else the snyk scan may fail

Build and deploy

Build process happens through Gradle (as well as all dependency's connection). Managed in build.gradle.kts root file, parametrised by gradle.properties file.

Release happens automatically every Tuesday at 9am UTC. Also, could be run manually through GitHub's Actions/Release workflow run. Specified in release.yml file.

Testing

Should be mostly done trough IntelliJ Platform Testing Framework and placed into integTest source root except simple independent Unit tests (test source root).

Mocks are not recommended by Jetbrains, but we heavily (and successfully) use Mockk framework. Just be careful not to mock whole world and make sure you're testing real functionality and not mocked one.

Running the extension

  • From the toolbar click Run -> Run
  • Click Edit Configuration -> Add new configuration
  • Select Gradle from the configuration list
  • Type runIde in the Run textbox to select the runIde run command
  • Click Apply and Run to run the extension`

Target specific IDE distribution

If you want to run the plugin in other IDE distribution (e.g. Rider), you should pass set IDE Contents directory as a localIdeDirectory property in gradle.properties.

Here's an example for local Rider installation: localIdeDirectory=/Users/michel/Library/Application Support/JetBrains/Toolbox/apps/Rider/ch-0/221.5787.36/Rider.app/Contents

You can copy the full path from IDE Settings in the JetBrains Toolbox.

Useful Links: