Skip to content

Commit 4e05026

Browse files
committed
Doc: plugin structure
1 parent 9b7dc83 commit 4e05026

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,30 @@ To manually install a local build:
3131
2. run `./gradlew clean buildPlugin` to generate a zip distribution
3232
3. locate the zip file in the `build/distributions` folder and follow [these instructions](https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk) on how to install a plugin from disk.
3333

34-
Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the one specified in `gradle.properties` - `platformVersion`) with the latest plugin changes deployed.
34+
Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the one specified in `gradle.properties` - `platformVersion`) with the latest plugin changes deployed.
35+
36+
### Plugin Structure
37+
```
38+
.
39+
├── .github/ GitHub Actions workflows and Dependabot configuration files
40+
├── gradle
41+
│ └── wrapper/ Gradle Wrapper
42+
├── build/ Output build directory
43+
├── src Plugin sources
44+
│ └── main
45+
│ ├── kotlin/ Kotlin production sources
46+
│ └── resources/ Resources - plugin.xml, icons, i8n
47+
│ └── test
48+
│ ├── kotlin/ Kotlin test sources
49+
├── .gitignore Git ignoring rules
50+
├── build.gradle.kts Gradle configuration
51+
├── CHANGELOG.md Full change history
52+
├── gradle.properties Gradle configuration properties
53+
├── gradlew *nix Gradle Wrapper script
54+
├── gradlew.bat Windows Gradle Wrapper script
55+
├── qodana.yml Qodana profile configuration file
56+
├── README.md README
57+
└── settings.gradle.kts Gradle project settings
58+
```
59+
60+
`src` directory is the most important part of the project, the Coder Gateway implementation and the manifest for the plugin – [plugin.xml][file:plugin.xml].

0 commit comments

Comments
 (0)