https://github.com/markiewb/idea-webstorm-pluginsetup-example

This is an example how to setup a plugin for WebStorm or IntelliJ IDEA Ultimate.
https://github.com/markiewb/idea-webstorm-pluginsetup-example

Last synced: about 1 year ago
JSON representation

This is an example how to setup a plugin for WebStorm or IntelliJ IDEA Ultimate.

• Host: GitHub
• URL: https://github.com/markiewb/idea-webstorm-pluginsetup-example
• Owner: markiewb
• License: apache-2.0
• Created: 2017-10-01T12:13:45.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-01T12:18:48.000Z (over 8 years ago)
• Last Synced: 2025-02-08T13:42:23.964Z (over 1 year ago)
• Language: Java
• Size: 589 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Example: How to setup a WebStorm-Plugin

This is an example how to setup a plugin for WebStorm or IntelliJ IDEA Ultimate. 

The plugin only purpose is to add the action "TSLint Format" to the code menu of the main menu, which invokes `com.intellij.lang.javascript.linter.tslint.fix.TsLintFileFixAction`. 

The plugin wants to access code from the TSLint plugin (provided only by the commercial JetBrains products above) 

and thus there was some more setup to do.

## Setup your own plugin

1. Create a new plugin via `File->New...-> New Project...-> IntelliJ Platform Plugin`

2. Setup your target platform/SDK to Webstorm

3. Add plugin-dependencies, you like to link to, to the SDK 

    * The dependencies are located in the plugin-folder of the target-platform

    * Do not add them as separate dependency to the plugin module, but to the SDK - [see forum](https://intellij-support.jetbrains.com/hc/en-us/community/posts/206762465-How-do-I-make-use-of-the-javascript-psi-)

    * ![SDK](https://raw.github.com/markiewb/idea-webstorm-pluginsetup-example/master/doc/SDK.png)

4. Add dependencies to the plugin.xml

    ```

    

    com.intellij.modules.lang

    

    JavaScript 

    

    tslint

    ```

5. Within your plugin, you can access the classes of the JavaScript- and TSLint plugin 

    * at compile time (provided by step 3)

    * at runtime (provided by step 3 and 4)