WebStorm Plugin Development

WebStorm is an IntelliJ Platform-based product. Plugin projects for WebStorm can be developed using IntelliJ IDEA with the Gradle IntelliJ Plugin.

Configuring Plugin Projects Targeting WebStorm

The configuration of WebStorm plugin projects follows the methods described in Configuring Plugin Projects using the IntelliJ IDEA Product Attribute and Configuring the plugin.xml File for PhpStorm.

The table below summarizes the Gradle IntelliJ Plugin attributes to set in the plugin project's Gradle build script. Click on an entry in the table's Attribute column to go to the documentation about that attribute. To see how these attributes appear in a similar Gradle build script for PhpStorm, see Configuring Gradle Build Script Using the IntelliJ IDEA Product Attribute.

`gradle-intellij-plugin` Attribute	Attribute Value
`intellij.type`	`IU` for IntelliJ IDEA Ultimate. (`IC` is incompatible with the required `JavaScriptLanguage` plugin)
`intellij.version`	`192.7142.36` Set to the same BRANCH.BUILD as the WebStorm target version.
`intellij.plugins`	Dependency on the `JavaScriptLanguage` plugin.
`runIde.ideDir`	Path to locally installed target version of WebStorm. For example, for macOS: /Users/$USERNAME$/Library/Application Support/JetBrains/Toolbox/apps/WebStorm/ch-0/192.7142.35/WebStorm.app/Contents.

The dependency on the WebStorm APIs must be declared in the plugin.xml file. As described in Modules Specific to Functionality table, the <depends> tags must declare JavaScriptLanguage. Note that for WebStorm, the plugin.xml file must also declare a dependency on com.intellij.modules.platform because JavaScriptLanguage is not recognized as a module. Consequently, without the com.intellij.modules.platform declaration the plugin is assumed to be a legacy plugin and will not load in WebStorm.

Available WebStorm APIs

Use the Exploring APIs as a Consumer process to identify the libraries JavaScriptLanguage.jar, and javascript-openapi.jar. Test your plugin with any version of WebStorm you wish to support.

Javascript Testframework

To use existing test base classes, specify com.jetbrains.intellij.javascript:javascript-test-framework:$VERSION$ as testImplementation dependency explicitly (see IntelliJ Platform Artifacts Repositories) (2020.3 and later).

Open Source Plugins for WebStorm

When learning new plugin development it is helpful to have some representative projects for reference:

Last modified: 29 九月 2022