Refactor: Extract duplicate pattern matching logic and fix event.waitUntil() timing

Co-authored-by: Christopher-C-Robinson <78235938+Christopher-C-Robinson@users.noreply.github.com>

Author: 2 people

src/extension.ts

@@ -8,7 +8,7 @@ import { fileExists, getDirectoryPath, getFullPath, getRelativePath, joinPath, r
 import { log, setLogger } from "./tsco-cli/source-code/source-code-logger";
 import { SourceCodeOrganizer } from "./tsco-cli/source-code/source-code-organizer";
 
-// #region Functions (10)
+// #region Functions (11)
 
 async function getConfiguration(configurationFilePath: string | null)
 {
@@ -79,6 +79,34 @@ function matches(pattern: string, text: string)
     return globToRegExp(pattern).test(text);
 }
 
+function shouldOrganizeFile(sourceCodeFilePathRelative: string, configuration: Configuration): { shouldOrganize: boolean, reason?: string }
+{
+    let include = true;
+    let exclude = false;
+
+    if (configuration.files.include.length > 0)
+    {
+        include = configuration.files.include.some(inc => matches(inc, sourceCodeFilePathRelative) || matches(inc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
+    }
+
+    if (configuration.files.exclude.length > 0)
+    {
+        exclude = configuration.files.exclude.some(exc => matches(exc, sourceCodeFilePathRelative) || matches(exc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
+    }
+
+    if (!include)
+    {
+        return { shouldOrganize: false, reason: "does not match file include patterns" };
+    }
+    
+    if (exclude)
+    {
+        return { shouldOrganize: false, reason: "matches file exclude patterns" };
+    }
+    
+    return { shouldOrganize: true };
+}
+
 async function onInitialize()
 {
     if (vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length > 0)
@@ -152,27 +180,20 @@ async function onSave(event: vscode.TextDocumentWillSaveEvent)
 
         if (matches("**/*.ts", sourceCodeFilePath))
         {
-            const configuration = await getConfiguration(settings.configurationFilePath);
-            const workspaceRootDirectoryPath = getWorkspaceRootDirectoryPath();
-            const sourceCodeDirectoryPath = workspaceRootDirectoryPath;
-            const sourceCodeFilePathRelative = getRelativePath(sourceCodeDirectoryPath, sourceCodeFilePath);
-
-            // test for include or exclude patterns
-            let include = true;
-            let exclude = false;
-
-            if (configuration.files.include.length > 0)
-            {
-                include = configuration.files.include.some(inc => matches(inc, sourceCodeFilePathRelative) || matches(inc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
-            }
-
-            if (configuration.files.exclude.length > 0)
-            {
-                exclude = configuration.files.exclude.some(exc => matches(exc, sourceCodeFilePathRelative) || matches(exc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
-            }
-
-            if (include && !exclude)
-            {
+            event.waitUntil((async () => {
+                const configuration = await getConfiguration(settings.configurationFilePath);
+                const workspaceRootDirectoryPath = getWorkspaceRootDirectoryPath();
+                const sourceCodeDirectoryPath = workspaceRootDirectoryPath;
+                const sourceCodeFilePathRelative = getRelativePath(sourceCodeDirectoryPath, sourceCodeFilePath);
+
+                const fileCheck = shouldOrganizeFile(sourceCodeFilePathRelative, configuration);
+                
+                if (!fileCheck.shouldOrganize)
+                {
+                    log(`tsco skipping organizing ${sourceCodeFilePath}, because it ${fileCheck.reason}`);
+                    return [];
+                }
+
                 const sourceCode = event.document.getText();
                 const organizedSourceCode = await SourceCodeOrganizer.organizeSourceCode(sourceCodeFilePath, sourceCode, configuration);
 
@@ -182,23 +203,16 @@ async function onSave(event: vscode.TextDocumentWillSaveEvent)
                     const end = new vscode.Position(event.document.lineCount - 1, event.document.lineAt(event.document.lineCount - 1).text.length);
                     const range = new vscode.Range(start, end);
 
-                    event.waitUntil(Promise.resolve([vscode.TextEdit.replace(range, organizedSourceCode)]));
-                    
                     log(`tsco organized ${sourceCodeFilePath}`);
+                    
+                    return [vscode.TextEdit.replace(range, organizedSourceCode)];
                 }
                 else
                 {
                     log(`tsco skipping organizing ${sourceCodeFilePath}, because it is already organized`);
+                    return [];
                 }
-            }
-            else if (!include)
-            {
-                log(`tsco skipping organizing ${sourceCodeFilePath}, because it does not match file include patterns`);
-            }
-            else if (exclude)
-            {
-                log(`tsco skipping organizing ${sourceCodeFilePath}, because it matches file exclude patterns`);
-            }
+            })());
         }
     }
 }
@@ -223,55 +237,38 @@ async function organize(sourceCodeFilePath: string, configuration: Configuration
     const sourceCodeDirectoryPath = workspaceRootDirectoryPath;
     const sourceCodeFilePathRelative = getRelativePath(sourceCodeDirectoryPath, sourceCodeFilePath);
 
-    // test for include or exclude patterns
-    let include = true;
-    let exclude = false;
-
-    if (configuration.files.include.length > 0)
+    const fileCheck = shouldOrganizeFile(sourceCodeFilePathRelative, configuration);
+    
+    if (!fileCheck.shouldOrganize)
     {
-        include = configuration.files.include.some(inc => matches(inc, sourceCodeFilePathRelative) || matches(inc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
+        log(`tsco skipping organizing ${sourceCodeFilePath}, because it ${fileCheck.reason}`);
+        return false;
     }
 
-    if (configuration.files.exclude.length > 0)
-    {
-        exclude = configuration.files.exclude.some(exc => matches(exc, sourceCodeFilePathRelative) || matches(exc, sourceCodeFilePathRelative.replaceAll("../", "").replaceAll("./", "")));
-    }
+    // organize and save
+    let editor = await getOpenedEditor(sourceCodeFilePath);
+    const sourceCode = editor ? editor.document.getText() : await readFile(sourceCodeFilePath);
+    const organizedSourceCode = await SourceCodeOrganizer.organizeSourceCode(sourceCodeFilePath, sourceCode, configuration);
 
-    if (include && !exclude)
+    if (organizedSourceCode !== sourceCode)
     {
-        // organize and save
-        let editor = await getOpenedEditor(sourceCodeFilePath);
-        const sourceCode = editor ? editor.document.getText() : await readFile(sourceCodeFilePath);
-        const organizedSourceCode = await SourceCodeOrganizer.organizeSourceCode(sourceCodeFilePath, sourceCode, configuration);
-
-        if (organizedSourceCode !== sourceCode)
-        {
-            editor ??= await openEditor(sourceCodeFilePath);
-            const start = new vscode.Position(0, 0);
-            const end = new vscode.Position(editor.document.lineCount, editor.document.lineAt(editor.document.lineCount - 1).text.length);
-            const range = new vscode.Range(start, end);
-            const edit = new vscode.WorkspaceEdit();
+        editor ??= await openEditor(sourceCodeFilePath);
+        const start = new vscode.Position(0, 0);
+        const end = new vscode.Position(editor.document.lineCount - 1, editor.document.lineAt(editor.document.lineCount - 1).text.length);
+        const range = new vscode.Range(start, end);
+        const edit = new vscode.WorkspaceEdit();
 
-            edit.replace(editor.document.uri, range, organizedSourceCode);
+        edit.replace(editor.document.uri, range, organizedSourceCode);
 
-            await vscode.workspace.applyEdit(edit);
+        await vscode.workspace.applyEdit(edit);
 
-            log(`tsco organized ${sourceCodeFilePath}`);
+        log(`tsco organized ${sourceCodeFilePath}`);
 
-            return true;
-        }
-        else
-        {
-            log(`tsco skipping organizing ${sourceCodeFilePath}, because it is already organized`);
-        }
+        return true;
     }
-    else if (!include)
-    {
-        log(`tsco skipping organizing ${sourceCodeFilePath}, because it does not match file include patterns`);
-    }
-    else if (exclude)
+    else
     {
-        log(`tsco skipping organizing ${sourceCodeFilePath}, because it matches file exclude patterns`);
+        log(`tsco skipping organizing ${sourceCodeFilePath}, because it is already organized`);
     }
 
     return false;