Merge pull request #41 from block/mehdi.idea-plugin-config

Make idea-plugin enabled by configuration per project

Author: mmollaverdi

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/FormatConfigurationService.kt

@@ -0,0 +1,34 @@
+package xyz.block.kotlinformatter.idea
+
+import com.intellij.openapi.components.Service
+import com.intellij.openapi.diagnostic.Logger
+import com.intellij.openapi.project.Project
+import xyz.block.kotlinformatter.idea.FormatOnSavePostStartupActivity.Companion
+import java.io.InputStreamReader
+import java.util.Properties
+
+@Service(Service.Level.PROJECT)
+class FormatConfigurationService(private val project: Project) {
+
+  // This is calculated once and on demand.
+  // Changes to the config file will require a restart.
+  val formattingEnabled by lazy {
+    val configFile = project.getFile(CONFIG_FILE_PATH)
+    val enabled = configFile?.let { file ->
+      val properties = Properties()
+      InputStreamReader(file.inputStream).use {
+        properties.load(it)
+        properties.getProperty(ENABLED_PROPERTY_NAME)?.toBoolean() == true
+      }
+    } ?: false
+
+    logger.info("Formatting enabled: $enabled")
+    enabled
+  }
+
+  companion object {
+    private const val CONFIG_FILE_PATH: String = ".idea/kotlin-formater.properties"
+    private const val ENABLED_PROPERTY_NAME: String = "kotlin-formatter.enabled"
+    private val logger = Logger.getInstance(FormatConfigurationService::class.java.name)
+  }
+}

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/FormatOnSaveListener.kt

@@ -30,6 +30,11 @@ class FormatOnSaveListener(private val project: Project, private val formatter:
   private val processedDocuments = ConcurrentHashMap.newKeySet<Document>()
 
   override fun beforeDocumentSaving(document: Document) {
+    if (!project.getService(FormatConfigurationService::class.java).formattingEnabled) {
+      logger.info("Formatting is not enabled")
+      return
+    }
+
     val file: VirtualFile = FileDocumentManager.getInstance().getFile(document) ?: return
     // All open projects will receive this event, skip if the file doesn't belong to the current project.
     if (!ProjectFileIndex.getInstance(project).isInProject(file)) return

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/KotlinReformatService.kt

@@ -5,14 +5,9 @@ import com.intellij.formatting.service.AsyncFormattingRequest
 import com.intellij.formatting.service.FormattingService
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.diagnostic.Logger
-import com.intellij.openapi.project.Project
-import com.intellij.openapi.project.guessProjectDir
-import com.intellij.openapi.util.io.FileUtilRt
-import com.intellij.openapi.vfs.VirtualFile
-import com.intellij.openapi.vfs.findFile
 import com.intellij.psi.PsiFile
 import xyz.block.kotlinformatter.Ktfmt
-import java.io.InputStreamReader
+import xyz.block.kotlinformatter.idea.KotlinReformatService.Companion.FORMATTING_IGNORE_FILE
 
 /**
  * A service that overrides the default IntelliJ formatting behavior for Kotlin files.
@@ -29,6 +24,11 @@ class KotlinReformatService : AsyncDocumentFormattingService() {
    * called.
    */
   override fun canFormat(file: PsiFile): Boolean {
+    if (!file.project.getService(FormatConfigurationService::class.java).formattingEnabled) {
+      LOG.info("Formatting is not enabled")
+      return false
+    }
+
     if (!file.name.endsWith(".kt")) return false
 
     return !isFormattingIgnored(file)
@@ -107,25 +107,6 @@ class KotlinReformatService : AsyncDocumentFormattingService() {
     return false
   }
 
-  private fun Project.getFileContent(filePath: String): String? {
-    val rootDir = this.guessProjectDir()
-    if (rootDir == null) {
-      LOG.info("The project root directory is null - skipping")
-      return null
-    }
-    val file = rootDir.findFile(filePath)
-    if (file == null) {
-      LOG.info("The file at $filePath is missing")
-      return null
-    }
-    return file.loadText()
-  }
-
-  private fun VirtualFile.loadText(): String =
-    InputStreamReader(this.inputStream).use { reader ->
-      return String(FileUtilRt.loadText(reader, this.length.toInt()))
-    }
-
   companion object {
     private val LOG = Logger.getInstance(KotlinReformatService::class.java)
     private const val FORMATTING_IGNORE_FILE = ".kotlin-formatter-ignore"

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/ProjectExtensions.kt

@@ -0,0 +1,31 @@
+package xyz.block.kotlinformatter.idea
+
+import com.intellij.openapi.diagnostic.Logger
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.project.guessProjectDir
+import com.intellij.openapi.util.io.FileUtilRt
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.openapi.vfs.findFile
+import java.io.InputStreamReader
+
+private val logger = Logger.getInstance(KotlinReformatService::class.java)
+
+fun Project.getFileContent(filePath: String): String? = getFile(filePath)?.loadText()
+
+fun Project.getFile(filePath: String): VirtualFile? {
+  val rootDir = this.guessProjectDir()
+  if (rootDir == null) {
+    logger.info("The project root directory is null - skipping")
+    return null
+  }
+  val file = rootDir.findFile(filePath)
+  if (file == null) {
+    logger.info("The file at $filePath is missing")
+  }
+  return file
+}
+
+private fun VirtualFile.loadText(): String =
+  InputStreamReader(this.inputStream).use { reader ->
+    return String(FileUtilRt.loadText(reader, this.length.toInt()))
+  }