You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-11Lines changed: 32 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,32 @@ Elm Plugin for JetBrains IDEs
2
2
=============================
3
3
4
4
<!-- Plugin description -->
5
-
Provides support for the Elm programming language.
5
+
Provides support for the [Elm programming language](https://elm-lang.org). This plugin is developed
6
+
by the [Elm Tooling community](https://github.com/elm-tooling/intellij-elm/).
7
+
8
+
Features:
9
+
10
+
- Code completion
11
+
- Go to declaration
12
+
- Go to symbol
13
+
- Find usages
14
+
- Type Inference and Type Checking
15
+
- Rename refactoring
16
+
- Introduce "variable" refactoring (let/in)
17
+
- Generate JSON encoders/decoders
18
+
- Generate type annotation for un-annotated function
19
+
- Graphical UI for running elm-test
20
+
- Re-format code using elm-format
21
+
- Detect unused code
22
+
- Detect and remove unused imports
23
+
- 'Add Import' quick fix for unresolved references
24
+
- Code folding
25
+
- Structure view
26
+
- Syntax highlighting
27
+
- WebGL/GLSL support
28
+
- Spell checking
29
+
- Lamdera platform support
30
+
6
31
<!-- Plugin description end -->
7
32
8
33
Should work on most, if not all, IntelliJ Platform IDEs: IDEA (Community and Ultimate), WebStorm, PyCharm, RubyMine and more. If not please raise an issue.
@@ -15,33 +40,29 @@ The original repo was [klazuka/intellij-elm](https://github.com/klazuka/intellij
15
40
16
41
## Install
17
42
18
-
> [!NOTE]
19
-
> This elm-tooling/intellij-elm repo has not yet been released to the JetBrains Marketplace. The Elm plugin you’ll find over there is from the original [intellij-elm/intellij-elm](https://github.com/intellij-elm/intellij-elm) repo. See the [History](#history) section for more information.
20
-
21
43
You may want to have some CLI tools --`elm` (the Elm compiler), [`elm-test`](docs/elm-test.md), [`elm-format`](docs/features/elm-format.md),
22
44
[`elm-review`](docs/features/elm-review.md) and [`lamdera`](docs/features/lamdera.md)-- installed for certain features of this plugin to work.
23
45
24
-
Install the first three with:
46
+
You can install these globally with:
25
47
26
48
```bash
27
-
sudo npm install -g elm elm-test elm-format elm-review
49
+
sudo npm install -g elm elm-test elm-format elm-review lamdera
28
50
```
29
51
30
52
**NOTE**: if you have [node](https://nodejs.org) installed using [nvm](https://github.com/nvm-sh/nvm), make sure to read [our NVM setup guide](docs/nvm.md).
31
53
32
-
To install the Lamdera Elm compiler, follow [their instructions](https://lamdera.com/start).
33
-
34
54
To install the plugin itself first make sure to uninstall all other Elm plugins you may have installed (this requires a restart of the IDE).
35
55
Some have reported that having two Elm plugins installed results in the IDE not starting but showing a seemingly unrelated error
36
56
(if you have this problem, there are [ways to fix it](https://intellij-support.jetbrains.com/hc/en-us/community/posts/360000524244-Disable-Uninstall-plugin-without-launching-Idea)).
37
57
38
-
From within a JetBrains IDE, go to `Settings` -> `Plugins` -> `Marketplace` and search for "TODO name of new plugin" (not yet available on the JetBrains Marketplace).
39
-
After installing the plugin, restart the IDE and then [open your existing Elm project](docs/existing-project.md) or [create a new project](docs/new-project.md).
58
+
From within a JetBrains IDE, go to `Settings` -> `Plugins` -> `Marketplace` and search for "Elm Language". If you get multiple hits look
59
+
for the most recently updated version, since there are still older versions of the plugin available. After installing the plugin,
60
+
restart the IDE and then [open your existing Elm project](docs/existing-project.md) or [create a new project](docs/new-project.md).
40
61
41
62
Alternatively you can install it manually by downloading a [release](https://github.com/elm-tooling/intellij-elm/releases) (or downloading the source and building it yourself) and
42
63
installing it with `Settings` -> `Plugins` -> `⚙️ (gear icon)` -> `Install plugin from disk...`
43
64
44
-
Once the plugin is installed it is advised to doublecheck all CLI tools are found by going to
65
+
Once the plugin is installed it is advised to double-check all CLI tools are found by going to
45
66
**Settings** -> **Languages & Frameworks** -> **Elm** and see the CLI tools.
0 commit comments