Merge pull request #562 from koxudaxi/feat-partial-formatting

fix: Add support for partial formatting using --range option

Author: koxudaxi

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [Unreleased]
+- fix: Add support for partial formatting using --range option [[#562](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/562)]
 - fix: fix format and fix action [[#559](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/559)]
 - fix: Improve error handling [[#554](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/554)]
 - feat: add features to lsp [[#550](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/550)]

src/com/koxudaxi/ruff/Ruff.kt

@@ -90,6 +90,7 @@ val NO_FIX_FORMAT_ARGS = ARGS_BASE + listOf("--no-fix", "--format", "json")
 val NO_FIX_OUTPUT_FORMAT_ARGS = ARGS_BASE + listOf("--no-fix", "--output-format", "json")
 val FORMAT_ARGS = listOf("format", "--force-exclude", "--quiet")
 val FORMAT_CHECK_ARGS = FORMAT_ARGS + listOf("--check")
+val FORMAT_RANGE_ARGS = listOf("--range")
 val LSP_ARGS_BASE = listOf("server")
 val PREVIEW_ARGS = listOf("--preview")
 val Project.LSP_ARGS: List<String>
@@ -714,3 +715,35 @@ private val RUFF_CONFIG: List<String> = listOf(PY_PROJECT_TOML, RUFF_TOML)
 val VirtualFile.isRuffConfig: Boolean
     get() = name in RUFF_CONFIG || name.endsWith(RUFF_TOML_SUFFIX)
 val Project.configService: RuffConfigService get() = RuffConfigService.getInstance(this)
+
+
+/**
+ * Returns the 1-indexed line and column numbers for the given offset in the string.
+ *
+ * @param offset the character offset within the string.
+ * @return a Pair where the first component is the line number and the second is the column number.
+ */
+fun String.getLineAndColumn(offset: Int): Pair<Int, Int> {
+    // Count the number of newline characters before the offset to determine the line number.
+    val line = this.substring(0, offset).count { it == '\n' } + 1
+    // Determine the column number by finding the position of the last newline.
+    val lastNewline = this.lastIndexOf('\n', offset - 1)
+    val column = if (lastNewline == -1) offset + 1 else offset - lastNewline
+    return line to column
+}
+
+/**
+ * Converts the given TextRange into a formatted string "<start_line>:<start_column>-<end_line>:<end_column>"
+ * using the provided full text to calculate the line and column numbers.
+ *
+ * @param text the full text content from which the TextRange was obtained.
+ * @return a formatted string representing the range.
+ */
+fun TextRange.formatRange(text: String): String {
+    val (startLine, startColumn) = text.getLineAndColumn(startOffset)
+    val (endLine, endColumn) = text.getLineAndColumn(endOffset)
+    return "$startLine:$startColumn-$endLine:$endColumn"
+}
+
+
+fun TextRange.formatRangeArgs(text: String): List<String> = FORMAT_RANGE_ARGS + listOf(formatRange(text))

src/com/koxudaxi/ruff/RuffAsyncFormatter.kt

@@ -10,7 +10,7 @@ import java.io.FileNotFoundException
 
 
 class RuffAsyncFormatter : AsyncDocumentFormattingService() {
-    private val FEATURES: Set<FormattingService.Feature> = setOf(FormattingService.Feature.AD_HOC_FORMATTING)
+    private val FEATURES: Set<FormattingService.Feature> = setOf(FormattingService.Feature.FORMAT_FRAGMENTS)
 
     override fun getFeatures(): Set<FormattingService.Feature> {
         return FEATURES
@@ -51,13 +51,29 @@ class RuffAsyncFormatter : AsyncDocumentFormattingService() {
                         return@runCatching
                     }
                     val sourceFile = formattingContext.containingFile.sourceFile
-                    val fixCommandArgs =
-                        generateCommandArgs(sourceFile, formattingContext.project.FIX_ARGS, false) ?: return@runCatching
                     val currentText = ioFile.readText()
-                    if (cancelled) {
-                        noUpdate()
+
+                    // Check if a formatting range is specified.
+                    val formatRange = request.formattingRanges.firstOrNull()?.let { selectedRange ->
+                        if (selectedRange.endOffset >= currentText.length) null
+                        else selectedRange
+                    }
+
+                    if (formatRange != null) {
+                        // When a range is specified, only run the format command.
+                        val formatCommandArgs = generateCommandArgs(sourceFile, FORMAT_ARGS + formatRange.formatRangeArgs(currentText), false)
+                            ?: return@runCatching
+                        val formatCommandStdout = runRuff(formatCommandArgs, currentText.toByteArray())
+                        if (formatCommandStdout == null) {
+                            request.onTextReady(null)
+                            return@runCatching
+                        }
+                        updateText(currentText, formatCommandStdout)
                         return@runCatching
                     }
+
+                    val fixCommandArgs = generateCommandArgs(sourceFile, formattingContext.project.FIX_ARGS, false)
+                        ?: return@runCatching
                     val fixCommandStdout = runRuff(fixCommandArgs, currentText.toByteArray())
                     if (fixCommandStdout == null) {
                         request.onTextReady(null)
@@ -68,10 +84,7 @@ class RuffAsyncFormatter : AsyncDocumentFormattingService() {
                         return@runCatching
                     }
                     val formatCommandArgs = generateCommandArgs(sourceFile, FORMAT_ARGS, false)
-                    if (formatCommandArgs == null) {
-                        updateText(currentText, fixCommandStdout)
-                        return@runCatching
-                    }
+                        ?: return@runCatching
                     if (cancelled) {
                         noUpdate()
                         return@runCatching
@@ -85,22 +98,14 @@ class RuffAsyncFormatter : AsyncDocumentFormattingService() {
 
                 }.onFailure { exception ->
                     when (exception) {
-                        is ProcessCanceledException -> { /* ignore */
-                        }
-
-                        is FileNotFoundException -> {
-                            noUpdate()
-                        }
-
-                        else -> {
-                            request.onError("Ruff Error", exception.localizedMessage)
-                        }
+                        is ProcessCanceledException -> { /* ignore */ }
+                        is FileNotFoundException -> noUpdate()
+                        else -> request.onError("Ruff Error", exception.localizedMessage)
                     }
                 }
             }
 
             override fun cancel(): Boolean {
-                // Signal cancellation.
                 cancelled = true
                 return true
             }