Intelij LSP integration plugin based on LSP4IJ

.github/workflows/build-intellij-plugin.yml

@@ -0,0 +1,199 @@
+# GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps:
+# - Validate Gradle Wrapper.
+# - Run 'test' and 'verifyPlugin' tasks.
+# - Run Qodana inspections.
+# - Run the 'buildPlugin' task and prepare artifact for further tests.
+# - Run the 'runPluginVerifier' task.
+# - Create a draft release.
+#
+# The workflow is triggered on push and pull_request events.
+#
+# GitHub Actions reference: https://help.github.com/en/actions
+#
+## JBIJPPTPL
+
+name: tinymist::build::intellij-plugin
+on:
+  workflow_call:
+
+jobs:
+  # Prepare the environment and build the plugin
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+      # Free GitHub Actions Environment Disk Space
+      - name: Maximize Build Space
+        uses: jlumbroso/[email protected]
+        with:
+          tool-cache: false
+          large-packages: false
+
+      # Check out the current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up the Java environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 21
+
+      # Setup Gradle
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      # Build plugin
+      - name: Build plugin
+        run: ./gradlew :intellij:buildPlugin
+
+      # Prepare plugin archive content for creating artifact
+      - name: Prepare Plugin Artifact
+        id: artifact
+        shell: bash
+        run: |
+          cd ${{ github.workspace }}/editors/intellij/build/distributions
+          FILENAME=`ls *.zip`
+          unzip "$FILENAME" -d content
+
+          echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT
+
+      # Store an already-built plugin as an artifact for downloading
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.artifact.outputs.filename }}
+          path: ./build/distributions/content/*/*
+
+  # Run tests and upload a code coverage report
+  test:
+    name: Test
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    steps:
+
+      # Free GitHub Actions Environment Disk Space
+      - name: Maximize Build Space
+        uses: jlumbroso/[email protected]
+        with:
+          tool-cache: false
+          large-packages: false
+
+      # Check out the current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up the Java environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 21
+
+      # Setup Gradle
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: true
+
+      # Run tests
+      - name: Run Tests
+        run: ./gradlew :intellij:check
+
+      # Collect Tests Result of failed tests
+      - name: Collect Tests Result
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: tests-result
+          path: ${{ github.workspace }}/build/reports/tests
+
+      # Upload the Kover report to CodeCov
+      - name: Upload Code Coverage Report
+        uses: codecov/codecov-action@v5
+        with:
+          files: ${{ github.workspace }}/build/reports/kover/report.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Run plugin structure verification along with IntelliJ Plugin Verifier
+  verify:
+    name: Verify plugin
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    steps:
+
+      # Free GitHub Actions Environment Disk Space
+      - name: Maximize Build Space
+        uses: jlumbroso/[email protected]
+        with:
+          tool-cache: false
+          large-packages: false
+
+      # Check out the current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up the Java environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 21
+
+      # Setup Gradle
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: true
+
+      # Run Verify Plugin task and IntelliJ Plugin Verifier tool
+      - name: Run Plugin Verification tasks
+        run: ./gradlew :intellij:verifyPlugin
+
+      # Collect Plugin Verifier Result
+      - name: Collect Plugin Verifier Result
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: pluginVerifier-result
+          path: ${{ github.workspace }}/build/reports/pluginVerifier
+
+  # Prepare a draft release for GitHub Releases page for the manual verification
+  # If accepted and published, the release workflow would be triggered
+  releaseDraft:
+    name: Release draft
+    if: github.event_name != 'pull_request'
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+
+      # Check out the current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Remove old release drafts by using the curl request for the available releases with a draft flag
+      - name: Remove Old Release Drafts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/{owner}/{repo}/releases \
+            --jq '.[] | select(.draft == true) | .id' \
+            | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{}
+
+      # Create a new release draft which is not publicly visible and requires manual acceptance
+      - name: Create Release Draft
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          VERSION=$(./gradlew :intellij:properties --property version --quiet --console=plain | tail -n 1 | cut -f2- -d ' ')
+          RELEASE_NOTE="./release_note.txt"
+          ./gradlew :intellij:getChangelog --unreleased --no-header --quiet --console=plain --output-file=$RELEASE_NOTE
+
+          gh release create $VERSION \
+            --draft \
+            --title $VERSION \
+            --notes-file $RELEASE_NOTE

.github/workflows/ci.yml

@@ -187,6 +187,9 @@ jobs:
   build-vscode-others:
     needs: [build-vsc-assets]
     uses: ./.github/workflows/build-vscode-others.yml
+
+  build-intellij:
+    uses: ./.github/workflows/build-intellij-plugin.yml
 
   publish-vscode:
     needs: [build-vscode, build-vscode-others] # , announce

.gitignore

@@ -9,7 +9,10 @@ editors/vscode/out/
 editors/lapce/out/
 /external/typst-preview
 /dist
+/build
 
 *.pdf
+refs/
+
 .vscode/*.code-workspace
-refs/
+.gradle

docs/dev-guide.md

@@ -28,7 +28,7 @@ To contribute to tinymist, you need to install the following tools:
 
 You don't have to configure anything to start developing tinymist. However, here we provide some tips to make your development experience better.
 
-- [@Myriad-Dreamin's VS Code Settings](#appendix-myriad-dreamins-vs-code-settings)
+- [@Myriad-Dreamin's VS Code Settings](./dev-guide/vscode-extension.md#appendix-myriad-dreamins-vs-code-settings)
 
 ## Building and Running
 
@@ -44,7 +44,9 @@ cargo build --release
 cargo build --profile=gh-release
 ```
 
-To run VS Code extension locally, open the repository in VS Code and press `F5` to start a debug session to extension. The VS Code extension also shows how we build and run the language server and the editor tools.
+To run VS Code extension locally, open the repository in VS Code and press `F5` to start a debug session to extension. The VS Code extension also shows how we build and run the language server and the editor tools. See [VS Code Extension](./dev-guide/vscode-extension.md) for more details.
+
+To run IntelliJ plugin, execute `./gradlew :intellij:runIde` in the root directory. See [IntelliJ Plugin](./dev-guide/intellij-plugin.md) for more details.
 
 ## Local Documentation
 
@@ -126,71 +128,3 @@ To run e2e tests for tinymist on Windows:
 ## Release on GitHub
 
 The code owners and maintainers of the release channels can check the [Release Guide](/dev-guide/release-instruction.md) to learn how to check and release the new version of tinymist.
-
-
-## APPENDIX: @Myriad-Dreamin's VS Code Settings
-
-Applies the workspace settings template:
-
-```
-cp .vscode/tinymist.code-workspace.tmpl.json .vscode/tinymist.code-workspace.json
-```
-
-And then open the workspace in VS Code.
-
-Rust Settings explained:
-
-This configuration enables clippy on save:
-
-```json
-{
-		"rust-analyzer.check.command": "clippy",
-}
-```
-
-This configuration wraps comments automatically:
-
-```json
-{
-		"rust-analyzer.rustfmt.extraArgs": ["--config=wrap_comments=true"],
-}
-```
-
-This configuration excludes the `target` folder from the file watcher:
-
-```json
-{
-  "files.watcherExclude": {
-    "**/target": true
-  },
-}
-```
-
-Typst Settings explained:
-
-This configuration help use the same fonts as the CI building tinymist docs:
-
-```json
-{
-  "tinymist.fontPaths": [
-    "assets/fonts"
-  ],
-}
-```
-
-Formatter Settings explained:
-
-This configuration runs formatters on save and using the `prettier` formatter:
-
-```json
-{
-  "[javascript]":{
-    "editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-  },
-  "[json]": {
-    "editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-}
-```