Merge branch 'develop'

Author: ahankinson

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## [Unreleased]
 
+## [5.2.0] - 2025-10-21
+*   Major code review and clean-up (@ahankinson)
+*   Fixes a plugin crash when using the expose function (@ahankinson)
+*   Restored the [dedicated documentation site](https://elm-tooling.github.io/intellij-elm/) (@ahankinson)
 
 ## [5.1.0] - 2025-08-05
 *   Moved the plugin to [elm-tooling/intellij](https://github.com/elm-tooling/intellij-elm) (@lydell)

docs/_config.yml

@@ -1 +1,4 @@
-theme: jekyll-theme-minimal
+title: Elm Language Plugin for JetBrains IDEs
+description: Provides support for the [Elm programming language](https://elm-lang.org). This plugin is developed by the [Elm Tooling community](https://github.com/elm-tooling/intellij-elm/).
+logo: /assets/pluginIcon.svg
+theme: jekyll-theme-minimal

docs/assets/pluginIcon.svg

@@ -55,7 +55,7 @@ There is a dropdown box labeled "Run tests using" and change it from "Gradle" to
 The only time when you would want to have Gradle run the tests is if you change the parser or lexer definition, in which case we would need Gradle to re-build the parser and lexer prior to running the tests.
 
 To run the tests the `elm`, `elm-format` and `elm-review` commands need to be on your `$PATH`.
-Lamdera also needs to be installed, but I managed to simply link `elm` to `lamdera`, like with:
+Lamdera also needs to be installed, but you can simply link `elm` to `lamdera`, e.g.,:
 
 ```bash
 sudo ln -s /usr/local/bin/elm /usr/local/bin/lamdera
@@ -71,4 +71,6 @@ https://docs.github.com/en/get-started/exploring-projects-on-github/contributing
 
 ## Questions
 
-Have a question? Try reaching out to us on [Elm Slack](https://elmlang.herokuapp.com/) or create a GitHub issue. 
+Have a question? Try reaching out to us on the [Incremental Elm Discord](https://incrementalelm.com/chat) (Specifically, the `#intellij-elm` channel): https://discord.com/channels/534524278847045633/727577900525682699.
+
+You can also open a [Discussion topic](https://github.com/elm-tooling/intellij-elm/discussions) on GitHub.

docs/contributing.md

@@ -11,8 +11,8 @@ This feature operates in the background as you type, and it results in increased
 
 This feature is enabled by default.
 
-The syntax error checker cannot be disabled, but you can turn off the type checker and and unresolved reference checker. Disable them by going to **IntelliJ Settings -> Editor -> Inspections -> Elm** and un-checking each inspection that you want to disable.
+The syntax error checker cannot be disabled, but you can turn off the type checker and unresolved reference checker. Disable them by going to **IntelliJ Settings -> Editor -> Inspections -> Elm** and un-checking each inspection that you want to disable.
 
 ## Demo
 
-![type checking](../assets/type_checking.gif)   
+![type checking](../assets/type_checking.gif)   

docs/features/live-error-checking.md

@@ -1,3 +1,62 @@
-# Moved
+This plugin provides support for the [Elm programming language](https://elm-lang.org). This plugin is developed
+by the [Elm Tooling community](https://github.com/elm-tooling/intellij-elm/).
+
+## Using the plugin
+
+Once the plugin is installed it is advised to double-check all CLI tools are found by going to `Settings` -> `Languages & Frameworks` -> `Elm` and see the CLI tools.
+
+After installing the plugin, restart the IDE and then [open your existing Elm project](existing-project.md) or [create a new project](new-project.md).
+
+## Install
+
+You may want to have some CLI tools --`elm` (the Elm compiler), [`elm-test`](features/elm-test.md), [`elm-format`](features/elm-format.md),
+[`elm-review`](features/elm-review.md) and [`lamdera`](features/lamdera.md)-- installed for certain features of this plugin to work.
+
+You can install these globally with:
+
+```bash
+sudo npm install -g elm elm-test elm-format elm-review lamdera
+```
+
+**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](nvm.md).
+
+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).
+Some have reported that having two Elm plugins installed results in the IDE not starting but showing a seemingly unrelated error
+(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)).
+
+From within a JetBrains IDE, go to `Settings` -> `Plugins` -> `Marketplace` and search for "Elm Language". If you get multiple hits look
+for the most recently updated version, since there are still older versions of the plugin available. 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 installing it with 
+`Settings` -> `Plugins` -> `⚙️ (gear icon)` -> `Install plugin from disk...`
+
+## Features
+
+* [Live error checking](features/live-error-checking.md)
+* [Generate JSON encoder and decoder functions](features/generate-function-json.md)
+* [Rename refactoring](features/rename-refactoring.md)
+* [Lamdera support](features/lamdera.md)
+* [Support for `elm-review`](features/elm-review.md)
+* [Type inference and type checking](features/type-inference.md)
+* [Find usages](features/find-usages.md)
+* [Run tests](features/elm-test.md) (elm-test)
+* [Reformat code using `elm-format`](features/elm-format.md) (elm-format)
+* [Cleanup unused imports](features/unused-imports.md)
+* [Detect unused code](features/unused-code.md)
+* ['Add Import' quick fix for unresolved references](features/add-imports.md)
+* [Quick Docs](features/quick-docs.md)
+* [Structure view and quick navigation](features/structure-view.md)
+* [WebGL/GLSL support](features/webgl.md)
+* [Code folding](features/code-folding.md)
+* [Manage exposing lists](features/exposure.md)
+
+Want to see it in action? This [10 minute video](https://www.youtube.com/watch?v=CC2TdNuZztI) demonstrates many of the features and how they work together.
+
+## Contributing
+
+Yes, please! See [our guide](/docs/contributing.md) on this topic.
+
+## Development and Building
+
+
+
 
-This webpage has been replaced by the [intellij-elm project README](https://github.com/klazuka/intellij-elm). 

docs/index.md

@@ -4,13 +4,14 @@
 pluginGroup = io.github.elm-tooling
 pluginName = Elm Language
 # SemVer format -> https://semver.org
-pluginVersion = 5.1.0
+pluginVersion = 5.2.0
 
 # We also set since and until build manually in `plugin.xml`. Keep them in sync!
 # See: https://intellij-support.jetbrains.com/hc/en-us/community/posts/360010590059-Why-pluginUntilBuild-is-mandatory
 pluginSinceBuild = 242
 # We do not set until build, as we want it to be compatible with new versions. See `plugin.xml`.
-pluginUntilBuild = 252.*
+# pluginUntilBuild = 252.*
+pluginUntilBuild =
 
 # IntelliJ Platform Properties -> https://github.com/JetBrains/gradle-intellij-plugin#intellij-platform-properties
 # 2022.3 and newer require JDK17

gradle.properties

@@ -20,6 +20,10 @@ import org.elm.workspace.elmWorkspace
 
 class ElmExternalFormatAction : AnAction() {
 
+    override fun getActionUpdateThread(): ActionUpdateThread {
+        return ActionUpdateThread.BGT
+    }
+
     override fun update(e: AnActionEvent) {
         super.update(e)
         e.presentation.isEnabled = getContext(e) != null

src/main/kotlin/org/elm/ide/actions/ElmExternalFormatAction.kt

@@ -2,26 +2,29 @@ package org.elm.ide.actions
 
 import com.intellij.execution.ExecutionException
 import com.intellij.notification.NotificationType
+import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.CommonDataKeys
 import com.intellij.openapi.actionSystem.PlatformDataKeys
-import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.fileEditor.FileEditorManager
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VfsUtil
 import com.intellij.openapi.vfs.VirtualFile
 import org.elm.ide.notifications.showBalloon
 import org.elm.lang.core.ElmFileType
 import org.elm.openapiext.saveAllDocuments
-import org.elm.workspace.*
 import org.elm.workspace.commandLineTools.makeProject
 import org.elm.workspace.compiler.findEntrypoints
-
-private val log = logger<ElmExternalReviewAction>()
+import org.elm.workspace.elmToolchain
+import org.elm.workspace.elmWorkspace
 
 class ElmExternalReviewAction : AnAction() {
 
+    override fun getActionUpdateThread(): ActionUpdateThread {
+        return ActionUpdateThread.BGT
+    }
+
     override fun update(e: AnActionEvent) {
         super.update(e)
         e.presentation.isEnabled = e.project != null
@@ -77,7 +80,7 @@ class ElmExternalReviewAction : AnAction() {
             if (compiledSuccessfully) {
                 elmReviewCLI.runReview(project, elmProject, project.elmToolchain.elmCLI, currentFileInEditor)
             }
-        } catch (e: ExecutionException) {
+        } catch (_: ExecutionException) {
             return showError(
                 project,
                 "Failed to 'make' or 'review'. Are the path settings correct ?",

src/main/kotlin/org/elm/ide/actions/ElmExternalReviewAction.kt

@@ -2,11 +2,11 @@ package org.elm.ide.actions
 
 import com.intellij.execution.ExecutionException
 import com.intellij.notification.NotificationType
+import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.CommonDataKeys
 import com.intellij.openapi.actionSystem.PlatformDataKeys
-import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.fileEditor.FileEditorManager
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VfsUtil
@@ -19,10 +19,12 @@ import org.elm.workspace.compiler.findEntrypoints
 import org.elm.workspace.elmToolchain
 import org.elm.workspace.elmWorkspace
 
-private val log = logger<ElmExternalReviewAction>()
-
 class ElmExternalReviewWatchmodeAction : AnAction() {
 
+    override fun getActionUpdateThread(): ActionUpdateThread {
+        return ActionUpdateThread.BGT
+    }
+
     override fun update(e: AnActionEvent) {
         super.update(e)
         e.presentation.isEnabled = e.project != null
@@ -78,7 +80,7 @@ class ElmExternalReviewWatchmodeAction : AnAction() {
             if (compiledSuccessfully) {
                 elmReviewCLI.watchReview(project, elmProject, project.elmToolchain.elmCLI)
             }
-        } catch (e: ExecutionException) {
+        } catch (_: ExecutionException) {
             return showError(
                 project,
                 "Failed to 'make' or 'review'. Are the path settings correct ?",