Merge pull request #59 from BlakeNeko/feature/trim-surrounding-spaces

Feature/#58 trim surrounding spaces

Author: newtextdoc1111

locales/en/settings.json

@@ -85,5 +85,9 @@
     },
     "AutocompletePlus_AutoFormatter_EnableAutoFormat": {
         "name": "Enable Auto Format"
+    },
+    "AutocompletePlus_AutoFormatter_TrimSurroundingSpaces": {
+        "name": "Trim Surrounding Spaces",
+        "tooltip": "When enabled, trim any blank lines from the beginning and end of the prompt."
     }
 }

locales/ja/settings.json

@@ -85,5 +85,9 @@
     },
     "AutocompletePlus_AutoFormatter_EnableAutoFormat": {
         "name": "自動フォーマット機能の有効化"
+    },
+    "AutocompletePlus_AutoFormatter_TrimSurroundingSpaces": {
+        "name": "先頭・末尾の空白を削除",
+        "tooltip": "有効時、プロンプトの先頭と末尾にある空行やスペースをすべて削除します。"
     }
 }

locales/zh-TW/settings.json

@@ -85,5 +85,9 @@
     },
     "AutocompletePlus_AutoFormatter_EnableAutoFormat": {
         "name": "啟用自動格式化"
+    },
+    "AutocompletePlus_AutoFormatter_TrimSurroundingSpaces": {
+        "name": "去除首尾空白",
+        "tooltip": "啟用時，清除提示詞開頭和結尾的所有空行和空格。"
     }
 }

locales/zh/settings.json

@@ -85,5 +85,9 @@
     },
     "AutocompletePlus_AutoFormatter_EnableAutoFormat": {
         "name": "启用自动格式化"
+    },
+    "AutocompletePlus_AutoFormatter_TrimSurroundingSpaces": {
+        "name": "去除首尾空白",
+        "tooltip": "启用时，清除提示词开头和结尾的所有空行和空格。"
     }
 }

tests/js/auto-formatter.test.js

@@ -47,15 +47,18 @@ describe('AutoFormatter Functions', () => {
     describe('formatPromptText', () => {
         // Store original setting value to restore after tests
         const originalUseTrailingComma = settingValues.useTrailingComma;
+        const originalTrimSurroundingSpaces = settingValues.trimSurroundingSpaces;
 
         afterEach(() => {
             // Restore original setting after each test
             settingValues.useTrailingComma = originalUseTrailingComma;
+            settingValues.trimSurroundingSpaces = originalTrimSurroundingSpaces;
         });
 
         describe('with useTrailingComma enabled', () => {
             beforeEach(() => {
                 settingValues.useTrailingComma = true;
+                settingValues.trimSurroundingSpaces = false;
             });
 
             test('should format text by adding comma and space after tags', () => {
@@ -101,6 +104,7 @@ describe('AutoFormatter Functions', () => {
         describe('with useTrailingComma disabled', () => {
             beforeEach(() => {
                 settingValues.useTrailingComma = false;
+                settingValues.trimSurroundingSpaces = false;
             });
 
             test('should format text by adding comma and space after tags without trailing comma', () => {
@@ -143,6 +147,59 @@ describe('AutoFormatter Functions', () => {
             });
         });
 
+        describe('with trimSurroundingSpaces enabled', () => {
+            beforeEach(() => {
+                settingValues.trimSurroundingSpaces = true;
+                settingValues.useTrailingComma = false;
+            });
+
+            test('should remove trailing newlines and spaces', () => {
+                const input = 'tag1, tag2\n\n  ';
+                const expected = 'tag1, tag2'; 
+                expect(formatPromptText(input)).toBe(expected);
+            });
+
+            test('should remove leading newlines and spaces', () => {
+                const input = '  \n\ntag1, tag2';
+                const expected = 'tag1, tag2';
+                expect(formatPromptText(input)).toBe(expected);
+            });
+
+            test('should remove both leading and trailing whitespaces but keep middle empty lines', () => {
+                const input = '  \n\ntag1\n\ntag2\n\n  ';
+                const expected = 'tag1\n\ntag2'; 
+                expect(formatPromptText(input)).toBe(expected);
+            });
+
+            test('should return empty string if input is only whitespace', () => {
+                const input = '   \n   ';
+                expect(formatPromptText(input)).toBe('');
+            });
+        });
+
+        describe('with trimSurroundingSpaces disabled', () => {
+            beforeEach(() => {
+                settingValues.trimSurroundingSpaces = false;
+                settingValues.useTrailingComma = false;
+            });
+
+            test('should preserve trailing newlines', () => {
+                const input = 'tag1, tag2\n\n';
+                const expected = 'tag1, tag2\n\n';
+                expect(formatPromptText(input)).toBe(expected);
+            });
+
+            test('should preserve leading spaces (as first line content)', () => {
+                const input = '   \ntag1';
+                const expected = '\ntag1'; 
+                expect(formatPromptText(input)).toBe(expected);
+            });
+
+            test('should handle input with only spaces', () => {
+                expect(formatPromptText('   ')).toBe('   ');
+            });
+        });
+
         test('should handle empty input', () => {
             expect(formatPromptText('')).toBe('');
             expect(formatPromptText(null)).toBe(null);

web/js/auto-formatter.js

@@ -7,15 +7,17 @@ import { NodeInfo } from './node-info.js';
  *
  * Format conditions:
  * 1. Skip formatting if node is in blocklist
- * 2. Skip formatting if text contains only numbers or single letters (separated by commas)
- * 3. Format if text contains "word + comma" pattern at least twice
- * 4. Otherwise, don't format
+ * 2. If text is empty after trimming, format only if trimSurroundingSpaces is enabled, otherwise don't format
+ * 3. Skip formatting if text contains only numbers or single letters (separated by commas)
+ * 4. Format if text contains "word + comma" pattern
+ * 5. Format if trimSurroundingSpaces is enabled and there are surrounding spaces or line breaks
+ * 6. Otherwise, don't format
  *
  * @param {NodeInfo} nodeInfo - The node information.
  * @returns {boolean} - True if the text should be formatted, false otherwise.
  */
 function shouldAutoFormat(text, nodeInfo) {
-    if (!text || text.trim().length === 0) return false;
+    if (!text) return false;
 
     // 1. Check if the node name is in the blocklist
     const blocklist = [
@@ -34,10 +36,14 @@ function shouldAutoFormat(text, nodeInfo) {
         // console.debug(`[Autocomplete-Plus] auto-formatter on blur => nodeType: ${nodeInfo.nodeType}, inputName: ${nodeInfo.inputName}`);
     }
 
-
     const trimmedText = text.trim();
 
-    // 2. Check if the text is purely numeric data or single-letter placeholders with commas
+    // 2. Check if the text is completely empty after trimming
+    if (trimmedText.length === 0) {
+        return settingValues.trimSurroundingSpaces;
+    }
+
+    // 3. Check if the text is purely numeric data or single-letter placeholders with commas
     // (e.g., "0,0,0,1,1,1" or "0.5, -1.2, 0.8" or "A,B,R" for LoRA Block Weight)
     const elements = trimmedText.split(',').map(el => el.trim());
     const isSingleLetterOrNumeric = elements.every(el => {
@@ -50,15 +56,18 @@ function shouldAutoFormat(text, nodeInfo) {
         return false; // Don't format numeric data or single-letter template patterns
     }
 
-    // 3. Check if the text contains the pattern "word + comma"
+    // 4. If text contains "word + comma" pattern, format it
     const wordCommaPattern = /\w+\s*,/g;
-    const matches = trimmedText.match(wordCommaPattern);
-
-    if (matches == null) {
-        return false;
+    if (trimmedText.match(wordCommaPattern)) {
+        return true;
     }
 
-    return true; // Text should be formatted
+    // 5. If trimSurroundingSpaces is enabled and there are surrounding spaces, format to trim them
+    if (settingValues.trimSurroundingSpaces && text !== trimmedText) {
+        return true;
+    }
+    
+    return false; // Otherwise, don't format
 }
 
 /**
@@ -68,10 +77,27 @@ function shouldAutoFormat(text, nodeInfo) {
  * @returns {string} - The formatted text.
  */
 export function formatPromptText(text) {
-    if (!text || text.trim().length === 0) return text;
+    // Handle null or undefined input
+    if (text == null) return text;
+
+    // If the text is empty or contains only spaces...
+    if (text.trim().length === 0) {
+        if (settingValues.trimSurroundingSpaces) {
+            // ...And trimSurroundingSpaces is enabled, return an empty string
+            return '';
+        } else {
+            // ...Otherwise, return the original text
+            return text;
+        }
+    }
+
+    let processedText = text;
+    if (settingValues.trimSurroundingSpaces) {
+        processedText = text.trim();
+    }
 
     // Split text into individual lines for processing
-    const lines = text.split('\n');
+    const lines = processedText.split('\n');
     const formattedLines = [];
 
     for (const line of lines) {

web/js/main.js

@@ -490,6 +490,17 @@ app.registerExtension({
         },
 
         // --- Auto format settings ---
+        {
+            id: id + '.AutoFormatter.TrimSurroundingSpaces',
+            name: 'Trim Surrounding Spaces',
+            tooltip: 'When enabled, trim any blank lines from the beginning and end of the prompt.',
+            type: 'boolean',
+            defaultValue: false,
+            category: [name, 'AutoFormatter', 'Trim Surrounding Spaces'],
+            onChange: (newVal, oldVal) => {
+                settingValues.trimSurroundingSpaces = newVal;
+            },
+        },
         {
             id: id + '.AutoFormatter.UseTrailingComma',
             name: 'Use Trailing Comma',

web/js/settings.js

@@ -25,6 +25,7 @@ export const settingValues = {
     enableAutoFormat: true,
     autoFormatTrigger: 'auto', // Options: 'auto' (format on blur + shortcut), 'manual' (shortcut only)
     useTrailingComma: false, // Whether to add comma at the end of each line
+    trimSurroundingSpaces: false, // Trim spaces around each tag
 
 
     // Internal logic settings