Merge pull request #25 from MarioAriasC/0.1.0

Version 0.1.0

Author: MarioAriasC

.github/workflows/build.yml

@@ -32,22 +32,26 @@ jobs:
       version: ${{ steps.properties.outputs.version }}
       changelog: ${{ steps.properties.outputs.changelog }}
     steps:
+      - name: Maximize Build Space
+        run: |
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
 
       # Check out current repository
       - name: Fetch Sources
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       # Validate wrapper
       - name: Gradle Wrapper Validation
         uses: gradle/wrapper-validation-action@v1.0.4
 
       # Setup Java 11 environment for the next steps
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: zulu
           java-version: 11
-          cache: gradle
 
       # Set environment variables
       - name: Export Properties
@@ -76,14 +80,14 @@ jobs:
       # Collect Tests Result of failed tests
       - name: Collect Tests Result
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: tests-result
           path: ${{ github.workspace }}/build/reports/tests
 
       # Cache Plugin Verifier IDEs
       - name: Setup Plugin Verifier IDEs Cache
-        uses: actions/cache@v2.1.7
+        uses: actions/cache@v3
         with:
           path: ${{ steps.properties.outputs.pluginVerifierHomeDir }}/ides
           key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }}
@@ -95,14 +99,14 @@ jobs:
       # Collect Plugin Verifier Result
       - name: Collect Plugin Verifier Result
         if: ${{ always() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: pluginVerifier-result
           path: ${{ github.workspace }}/build/reports/pluginVerifier
 
       # Run Qodana inspections
       - name: Qodana - Code Inspection
-        uses: JetBrains/qodana-action@v4.2.5
+        uses: JetBrains/qodana-action@v2022.2.1
 
       # Prepare plugin archive content for creating artifact
       - name: Prepare Plugin Artifact
@@ -117,7 +121,7 @@ jobs:
 
       # Store already-built plugin as an artifact for downloading
       - name: Upload artifact
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ steps.artifact.outputs.filename }}
           path: ./build/distributions/content/*/*
@@ -129,11 +133,13 @@ jobs:
     if: github.event_name != 'pull_request'
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
 
       # Check out current repository
       - name: Fetch Sources
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       # Remove old release drafts by using the curl request for the available releases with draft flag
       - name: Remove Old Release Drafts

.github/workflows/release.yml

@@ -12,11 +12,14 @@ jobs:
   release:
     name: Publish Plugin
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
 
       # Check out current repository
       - name: Fetch Sources
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.event.release.tag_name }}
 

.github/workflows/run-ui-tests.yml

@@ -33,11 +33,11 @@ jobs:
 
       # Check out current repository
       - name: Fetch Sources
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       # Setup Java 11 environment for the next steps
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: zulu
           java-version: 11

CHANGELOG.md

@@ -3,18 +3,22 @@
 # zig-support Changelog
 
 ## [Unreleased]
+### Added
 
+- [#24](https://github.com/MarioAriasC/zig-support/issues/24) Use `zig fmt` to format `*.zig` files. You can use
+  the `Reformat code` action (By default `Cmd/Ctrl + Alt + L`)
+- Updated to the latest JetBrain's IntelliJ platform plugin version.
 ## [0.0.7]
-### Added
-- More Live Templates for Zig:
-  - `St` -> `[]const u8`
-  - `tst` -> Creates a test: `test "" {}`
-  - `csd` -> Constant `Self` declaration: `const Self = @This();`
-  - `ced` -> Enum
-  - `cstd` -> Struct
-  - `fn0` -> Function without parameters
-  - `fn1` -> Function with one parameter
-  - `fn2` -> Function with two parameters
+### Added
+- More Live Templates for Zig:
+  - `St` -> `[]const u8`
+  - `tst` -> Creates a test: `test "" {}`
+  - `csd` -> Constant `Self` declaration: `const Self = @This();`
+  - `ced` -> Enum
+  - `cstd` -> Struct
+  - `fn0` -> Function without parameters
+  - `fn1` -> Function with one parameter
+  - `fn2` -> Function with two parameters
 - Support for the new IDEA platform version 2022.2
 
 ## [0.0.6]

build.gradle.kts

@@ -9,9 +9,9 @@ plugins {
     // Java support
     id("java")
     // Kotlin support
-    id("org.jetbrains.kotlin.jvm") version "1.6.10"
+    id("org.jetbrains.kotlin.jvm") version "1.7.10"
     // Gradle IntelliJ Plugin
-    id("org.jetbrains.intellij") version "1.4.0"
+    id("org.jetbrains.intellij") version "1.8.0"
     // Gradle Changelog Plugin
     id("org.jetbrains.changelog") version "1.3.1"
     // Gradle Qodana Plugin
@@ -34,6 +34,12 @@ sourceSets {
     }
 }
 
+kotlin {
+    jvmToolchain {
+        languageVersion.set(JavaLanguageVersion.of(11))
+    }
+}
+
 // Configure Gradle IntelliJ Plugin - read more: https://github.com/JetBrains/gradle-intellij-plugin
 intellij {
     pluginName.set(properties("pluginName"))
@@ -77,16 +83,6 @@ val generateZigLexer = task<GenerateLexer>("generateZigLexer") {
 }
 
 tasks {
-    // Set the JVM compatibility versions
-    properties("javaVersion").let {
-        withType<JavaCompile> {
-            sourceCompatibility = it
-            targetCompatibility = it
-        }
-        withType<KotlinCompile> {
-            kotlinOptions.jvmTarget = it
-        }
-    }
 
     wrapper {
         gradleVersion = properties("gradleVersion")

gradle.properties

@@ -3,7 +3,7 @@
 
 pluginGroup = com.github.marioariasc.zigsupport
 pluginName = zig-support
-pluginVersion = 0.0.7
+pluginVersion = 0.1.0
 
 # See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 # for insight into build numbers and IntelliJ Platform versions.
@@ -21,7 +21,7 @@ platformPlugins =
 # Java language level used to compile sources and to generate the files for - Java 11 is required since 2020.3
 javaVersion = 11
 
-gradleVersion = 7.4
+gradleVersion = 7.5.1
 
 # Opt-out flag for bundling Kotlin standard library.
 # See https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library for details.

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -205,6 +205,10 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+if ! command -v  xargs >/dev/null 2>&1
+then
+  die "xargs is not available"
+fi
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,7 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

qodana.yml

@@ -4,3 +4,7 @@
 version: 1.0
 profile:
   name: qodana.recommended
+exclude:
+  - name: All
+    paths:
+      - .qodana

src/main/kotlin/org/ziglang/jb/ZigLang.kt

@@ -1,9 +1,16 @@
 package org.ziglang.jb
 
+import com.intellij.execution.configurations.PathEnvironmentVariableUtil
 import com.intellij.lang.Language
 import org.ziglang.jb.reference.createLookup
 
 object ZigLang : Language("Zig") {
+    const val NOTIFICATION_GROUP_ID = "Zig"
+
+    val zigPath: String? by lazy {
+        PathEnvironmentVariableUtil.findInPath("zig")?.absolutePath
+    }
+
     val primitiveTypes = listOf(
         "i8",
         "u8",

src/main/kotlin/org/ziglang/jb/formatter/ZigExternalFormatter.kt

@@ -0,0 +1,63 @@
+package org.ziglang.jb.formatter
+
+import com.intellij.execution.configurations.GeneralCommandLine
+import com.intellij.execution.process.CapturingProcessAdapter
+import com.intellij.execution.process.OSProcessHandler
+import com.intellij.execution.process.ProcessEvent
+import com.intellij.formatting.service.AsyncDocumentFormattingService
+import com.intellij.formatting.service.AsyncFormattingRequest
+import com.intellij.formatting.service.FormattingService
+import com.intellij.psi.PsiFile
+import org.ziglang.jb.ZigLang
+import org.ziglang.jb.psi.ZigFile
+import java.nio.charset.StandardCharsets
+
+private const val FMT = "fmt"
+
+private const val STDIN = "--stdin"
+
+class ZigExternalFormatter : AsyncDocumentFormattingService() {
+    override fun getFeatures(): MutableSet<FormattingService.Feature> = mutableSetOf(
+        FormattingService.Feature.FORMAT_FRAGMENTS,
+        FormattingService.Feature.AD_HOC_FORMATTING,
+        FormattingService.Feature.OPTIMIZE_IMPORTS
+    )
+
+    override fun canFormat(psiFile: PsiFile): Boolean = psiFile is ZigFile
+
+    override fun createFormattingTask(request: AsyncFormattingRequest): FormattingTask? {
+        val zigPath = ZigLang.zigPath ?: return null
+        val params = listOf(FMT, STDIN)
+        val commandLine =
+            GeneralCommandLine().withParentEnvironmentType(GeneralCommandLine.ParentEnvironmentType.CONSOLE)
+                .withExePath(zigPath).withParameters(params)
+        val handler = OSProcessHandler(commandLine.withCharset(StandardCharsets.UTF_8))
+        return object : FormattingTask {
+            override fun run() {
+                handler.processInput.use { out -> out.write(request.documentText.toByteArray()) }
+                handler.addProcessListener(object : CapturingProcessAdapter() {
+                    override fun processTerminated(event: ProcessEvent) {
+                        val exitCode = event.exitCode
+                        if(exitCode == 0) {
+                            request.onTextReady(output.stdout)
+                        } else {
+                            request.onError(ZigLang.NOTIFICATION_GROUP_ID, output.stderr)
+                        }
+                    }
+                })
+                handler.startNotify()
+            }
+
+            override fun cancel(): Boolean {
+                handler.destroyProcess()
+                return true
+            }
+
+        }
+
+    }
+
+    override fun getNotificationGroupId(): String = ZigLang.NOTIFICATION_GROUP_ID
+
+    override fun getName(): String = ZigLang.NOTIFICATION_GROUP_ID
+}

src/main/kotlin/org/ziglang/jb/project/ZigSdkType.kt

@@ -0,0 +1,28 @@
+package org.ziglang.jb.project
+
+import com.intellij.openapi.projectRoots.*
+import org.jdom.Element
+
+class ZigSdkType : SdkType("Zig") {
+    override fun saveAdditionalData(p0: SdkAdditionalData, p1: Element) {
+        TODO("Not yet implemented")
+    }
+
+    override fun suggestHomePath(): String? {
+        TODO("Not yet implemented")
+    }
+
+    override fun isValidSdkHome(p0: String): Boolean {
+        TODO("Not yet implemented")
+    }
+
+    override fun suggestSdkName(p0: String?, p1: String): String {
+        TODO("Not yet implemented")
+    }
+
+    override fun createAdditionalDataConfigurable(p0: SdkModel, p1: SdkModificator): AdditionalDataConfigurable? {
+        TODO("Not yet implemented")
+    }
+
+    override fun getPresentableName(): String = "Zig SDK"
+}