merge: solved merge with release-0.1.4

matheusferreirazup · matheusferreirazup · commit 692ac5058921 · 2022-09-14T16:43:31.000-03:00
Signed-off-by: Matheus Ferreira &lt;matheus.ferreira@zup.com.br&gt;
diff --git a/.github/release.yaml b/.github/release.yaml
@@ -19,12 +19,15 @@ changelog:
     labels:
       - ignore-for-release
   categories:
-    - title: Breaking Changes 🛠
+    - title: Breaking Changes 💥
       labels:
         - breaking-change
     - title: Exciting New Features 🎉
       labels:
         - enhancement
+    - title: Bug Fixes 🛠
+      labels:
+        - bug
     - title: Other Changes
       labels:
         - "*"
diff --git a/.github/workflows/check-callback.yml b/.github/workflows/check-callback.yml
@@ -55,11 +55,11 @@ jobs:
                     "description": "Internal error",
                     "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
                   }'
-    
+
   PUSBLISH:
-    if: ${{ success() &&  github.event.event_type == 'RELEASED' }}
+    if: ${{ success() && github.event.event_type == 'RELEASED' }}
     uses: stack-spot/stackspot-intellij-extension/.github/workflows/publish-release.yml@main
     secrets:
-      ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-      PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
-      CHANNEL: ${{ secrets.CHANNEL }}
+      accessToken: ${{ secrets.ACCESS_TOKEN }}
+      publishToken: ${{ secrets.PUBLISH_TOKEN }}
+      marketplaceChannel: ${{ secrets.MARKETPLACE_CHANNEL }}
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -19,11 +19,11 @@ name: Publish Release
 on:
   workflow_call:
     secrets:
-      ACCESS_TOKEN:
+      accessToken:
         required: true
-      PUBLISH_TOKEN:
+      publishToken:
         required: true
-      CHANNEL:
+      marketplaceChannel:
         required: true
 
 concurrency:
@@ -67,8 +67,8 @@ jobs:
       # Publish the plugin to the Marketplace
       - name: Publish Plugin
         env:
-          PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
-          CHANNEL: ${{ secrets.CHANNEL }}
+          PUBLISH_TOKEN: ${{ secrets.publishToken }}
+          MARKETPLACE_CHANNEL: ${{ secrets.marketplaceChannel }}
         run: |
           TAG=${{ github.event.release.tag_name }}
           TAG="${TAG//v/""}"
@@ -77,7 +77,7 @@ jobs:
       # Upload artifact as a release asset
       - name: Upload Release Asset
         env:
-          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.accessToken }}
         run: |
           gh release upload ${{ github.event.release.tag_name }} ./build/distributions/*
 
@@ -104,7 +104,7 @@ jobs:
       - name: Create Pull Request
         if: ${{ needs.EXPORT_PROPERTIES.outputs.changelog != '' }}
         env:
-          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.accessToken }}
         run: |
           VERSION="${{ github.event.release.tag_name }}"
           BRANCH="changelog-update-$VERSION"
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ Using StackSpot tool window after project opened:
 ## **Documentation**
 
 Check our official documentation page to use StackSpot IntelliJ plugin:
-[Documentation link](https://docs.stackspot.com/latest/)
+[Documentation link](https://docs.stackspot.com/latest/docs/extensions-for-ide/intellij/)
 
 ## **Contributing**
 
diff --git a/src/main/kotlin/com/stackspot/constants/Constants.kt b/src/main/kotlin/com/stackspot/constants/Constants.kt
@@ -38,10 +38,5 @@ object Constants {
         val USER_HOME: Path = Path(System.getProperty("user.home"))
         val STK_HOME: Path = USER_HOME.resolve(".stk")
         val STK_BIN: Path = STK_HOME.resolve("bin")
-        val STACKS_DIR: Path = if (STK_HOME.resolve("stacks").exists()) {
-            STK_HOME.resolve("stacks")
-        } else {
-            STK_HOME.resolve("plugins")
-        }
     }
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/actions/ImportStackAction.kt b/src/main/kotlin/com/stackspot/intellij/actions/ImportStackAction.kt
@@ -22,6 +22,9 @@ import com.intellij.openapi.project.DumbAware
 import com.intellij.openapi.ui.Messages
 import com.stackspot.intellij.commands.listeners.NotifyStacksUpdatedCommandListener
 import com.stackspot.intellij.commands.stk.ImportStack
+import com.stackspot.intellij.commons.ErrorDialog
+import com.stackspot.intellij.commons.InputDialog.REPOSITORY_URL
+import com.stackspot.intellij.commons.isUrlValid
 import com.stackspot.intellij.ui.Icons
 import com.stackspot.intellij.ui.StackSpotTerminalRunner
 
@@ -30,14 +33,20 @@ const val IMPORT_STACK = "Import Stack"
 
 class ImportStackAction : AnAction(IMPORT_STACK, IMPORT_STACK, Icons.IMPORT_STACK), DumbAware {
     override fun actionPerformed(e: AnActionEvent) {
-        val stackUrl = askForStackUrl()
+        val stackUrl = askForStackUrl() ?: return
+
+        if (!stackUrl.isUrlValid()) {
+            Messages.showErrorDialog(ErrorDialog.URL_IS_NOT_VALID_MESSAGE, ErrorDialog.URL_IS_NOT_VALID_TITLE)
+            return
+        }
+
         val project = e.project
-        if (stackUrl != null && project != null) {
+        if (project != null) {
             ImportStack(stackUrl, StackSpotTerminalRunner(project)).run(NotifyStacksUpdatedCommandListener())
         }
     }
 
     private fun askForStackUrl(): String? {
-        return Messages.showInputDialog("Enter Stack GIT URL To Import", IMPORT_STACK, Messages.getQuestionIcon())
+        return Messages.showInputDialog(REPOSITORY_URL, IMPORT_STACK, Messages.getQuestionIcon())
     }
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commons/UrlDialogExtension.kt b/src/main/kotlin/com/stackspot/intellij/commons/UrlDialogExtension.kt
@@ -0,0 +1,15 @@
+package com.stackspot.intellij.commons
+
+object InputDialog {
+    const val REPOSITORY_URL = "Insert a stack repository URL"
+}
+
+object ErrorDialog {
+    const val URL_IS_NOT_VALID_MESSAGE = "Requested URL is not valid"
+    const val URL_IS_NOT_VALID_TITLE = "Invalid URL"
+}
+
+fun String?.isUrlValid(): Boolean {
+    val regex = """((git|ssh|https)|(git@[\w\.]+))(:(//)?)([\w\.@\:/\-~]+)(/)?""".toRegex()
+    return (this?.isNotEmpty() == true) && regex.matches(this)
+}
diff --git a/src/main/kotlin/com/stackspot/intellij/services/CreateProjectService.kt b/src/main/kotlin/com/stackspot/intellij/services/CreateProjectService.kt
@@ -37,7 +37,7 @@ class CreateProjectService {
         get() {
             return if (!Constants.Paths.STK_BIN.exists()) {
                 ProjectWizardState.NOT_INSTALLED
-            } else if (ImportedStacks().list().isEmpty()) {
+            } else if (!ImportedStacks().hasStackFiles()) {
                 ProjectWizardState.STACKFILES_EMPTY
             } else if (!isGitConfigOk()) {
                 ProjectWizardState.GIT_CONFIG_NOT_OK
diff --git a/src/main/kotlin/com/stackspot/intellij/ui/project_wizard/panels/StackSpotNoStackfilesErrorPanel.kt b/src/main/kotlin/com/stackspot/intellij/ui/project_wizard/panels/StackSpotNoStackfilesErrorPanel.kt
@@ -24,6 +24,10 @@ import com.stackspot.intellij.actions.IMPORT_STACK
 import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.listeners.NotifyProjectWizardImportedStack
 import com.stackspot.intellij.commands.stk.ImportStack
+import com.stackspot.intellij.commons.ErrorDialog.URL_IS_NOT_VALID_MESSAGE
+import com.stackspot.intellij.commons.ErrorDialog.URL_IS_NOT_VALID_TITLE
+import com.stackspot.intellij.commons.InputDialog.REPOSITORY_URL
+import com.stackspot.intellij.commons.isUrlValid
 import java.util.concurrent.Executors
 import javax.swing.JComponent
 
@@ -33,7 +37,7 @@ class StackSpotNoStackfilesErrorPanel(val parentPanel: StackSpotParentPanel) {
         return panel {
             row {
                 text(
-                    "In order to create a StackSpot project, you need to have stacks imported.",
+                    "In order to create a StackSpot project, you need to have stacks imported with <b>stackfiles.</b>",
                     maxLineLength = 80
                 )
             }
@@ -57,20 +61,25 @@ class StackSpotNoStackfilesErrorPanel(val parentPanel: StackSpotParentPanel) {
     }
 
     private fun askForStackUrl(): String? {
-        return Messages.showInputDialog("Enter Stack GIT URL To Import", IMPORT_STACK, Messages.getQuestionIcon())
+        return Messages.showInputDialog(REPOSITORY_URL, IMPORT_STACK, Messages.getQuestionIcon())
     }
 
     private fun runImportStack() {
-        val url = askForStackUrl()
+        val url = askForStackUrl() ?: return
+
+        if (!url.isUrlValid()) {
+            Messages.showErrorDialog(URL_IS_NOT_VALID_MESSAGE, URL_IS_NOT_VALID_TITLE)
+            return
+        }
+
         parentPanel.showImportingStack()
+
         val executor = Executors.newSingleThreadExecutor()
         executor.submit {
-            if (!url.isNullOrEmpty()) {
                 ImportStack(url, BackgroundCommandRunner(Constants.Paths.STK_HOME.toString()))
                     .run(NotifyProjectWizardImportedStack(parentPanel))
-            }
         }
         executor.shutdown()
     }
 
-}
+}
diff --git a/src/main/kotlin/com/stackspot/model/ImportedStacks.kt b/src/main/kotlin/com/stackspot/model/ImportedStacks.kt
@@ -18,11 +18,15 @@ package com.stackspot.model
 
 import com.stackspot.constants.Constants
 import com.stackspot.yaml.parseStackYaml
+import java.nio.file.Path
+import kotlin.io.path.exists
 
 class ImportedStacks {
 
+    fun hasStackFiles() = list().any { it.listStackfiles().isNotEmpty() }
+
     fun list(): List<Stack> {
-        val stacksDir = Constants.Paths.STACKS_DIR.toFile()
+        val stacksDir = getStacksDirPath().toFile()
         return stacksDir.walk().filter {
             it.isDirectory
         }.mapNotNull {
@@ -35,4 +39,15 @@ class ImportedStacks {
     fun getByName(name: String): Stack? {
         return list().firstOrNull { it.name == name }
     }
+
+    private fun getStacksDirPath(): Path {
+        val stkHome = Constants.Paths.STK_HOME
+        val stacks = stkHome.resolve("stacks")
+        val stackDir: Path = if (stacks.exists()) {
+            stacks
+        } else {
+            stkHome.resolve("plugins")
+        }
+        return stackDir
+    }
 }
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -29,9 +29,22 @@
     <!-- Description of the plugin displayed on the Plugin Page and IDE Plugin Manager.
          Simple HTML elements (text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
          Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
-    <description><![CDATA[
-    StackSpot CLI integration with Jetbrains IDEs
-  ]]></description>
+    <description>
+        <![CDATA[
+            <html>
+                <p>StackSpot's plugin for JetBrains helps you import and use Stacks from your IDE. It allows you to create projects without changing your tool during development. It has an exclusive menu and an easy interface.</p>
+
+                <p><b>Features:</b></p>
+                <p>StackSpot's Extension for IDE gives you a better view of your project's Stacks, Stackfiles, and Plugins. You can also:</p>
+                <ul>
+                  <li>Import Stacks and apply Plugins without using STK CLI.</li>
+                  <li>Create projects with Stacks.</li>
+                  <li>Apply Plugins to your projects.</li>
+                  <li>Use STK CLI on IntelliJ's terminal.</li>
+                </ul>
+            </html>
+        ]]>
+    </description>
 
     <!-- Product and plugin compatibility requirements.
          Read more: https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html -->

Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,5 @@ object Constants {`
`38`	`38`	`val USER_HOME: Path = Path(System.getProperty("user.home"))`
`39`	`39`	`val STK_HOME: Path = USER_HOME.resolve(".stk")`
`40`	`40`	`val STK_BIN: Path = STK_HOME.resolve("bin")`
`41`		`- val STACKS_DIR: Path = if (STK_HOME.resolve("stacks").exists()) {`
`42`		`- STK_HOME.resolve("stacks")`
`43`		`- } else {`
`44`		`- STK_HOME.resolve("plugins")`
`45`		`- }`
`46`	`41`	`}`
`47`	`42`	`}`