Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.9 KB

README.md

File metadata and controls

66 lines (42 loc) · 2.9 KB

Svelte IDE plugin. WebStorm, IntelliJ IDEA, more.

Build Version Downloads Twitter Follow

Support for Svelte in your IDE of choice.

Features

  • Syntax highlighting
  • Code formatting
  • Typing assistance
  • Emmet-style abbreviations of Svelte blocks
  • Completions of components, props and some directives
  • Auto import of components
  • Navigation from components to their definition
  • Debugger integration

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "Svelte" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Compatible IDEs

Works in JavaScript-enabled JetBrains IDEs. Information about version compatibility and older releases is available in version history.

Contributing

Contributions are very much welcome!

IntelliJ Platform runs on JVM, yet Kotlin feels a lot like TypeScript. IntelliJ Platform SDK documentation is a good starting point.

Building and running the plugin

You'll need IntelliJ IDEA. The Community Edition is free and sufficient, you can also use Ultimate edition if you have one.

Clone the repository and run ./gradlew runIde (There are also intermediate tasks).

IntelliJ Ultimate will download in a bit, and you'll be prompted with license dialog - choose evaluation mode.

Ready to share .zip archive can be found in build/distributions after running ./gradlew buildPlugin.

Running tests

Tests can be run with ./gradlew test command or even better or by using run action in IntelliJ IDEA.

Writing Tests

Some tests in IntelliJ Platform are similar to Jest snapshots.

You need to create a .svelte file in scr/test/resources directory and add function composed of the word test and file name to appropriate class. When running test for the first time, file with expected results will be created, please commit it. When updating test, simply delete snapshot file and rerun test.