Merge pull request #65 from bradymholt/config-file-override

Ignore settings if configFile setting supplied
bradymholt · May 8, 2023 · 81448d0 · 81448d0
2 parents 2fb3f33 + 7e3f0ca
commit 81448d0
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -52,8 +52,8 @@ This extension has the following configuration settings:
 * `pgFormatter.extraFunction` - Path to file containing a list of function names to use the same formatting as PostgreSQL internal functions
 * `pgFormatter.noSpaceFunction` - Remove the space character between a function call and the open parenthesis that follows (Default: `true`)
 * `pgFormatter.pgFormatterPath` - Path to custom pg_format version
-* `pgFormatter.configFile` - Path to a pg_format config file
 * `pgFormatter.perlBinPath` - The path to the perl executable (Default: `"perl"`)
+* `pgFormatter.configFile` - The _absolute_ path to a [pg_format config file](https://github.com/darold/pgFormatter/blob/master/README).  **If this is set, all other extension settings are ignored.**  You can use a VS Code path variable to help resolve the absolute path (example: `${workspaceFolder}/pg_format.conf`).
 
 ### Ignoring Files
 

diff --git a/src/extension.ts b/src/extension.ts
@@ -7,12 +7,7 @@ import { substituteVariables } from "./configUtilities";
 
 function fullDocumentRange(document: vscode.TextDocument): vscode.Range {
   const lastLineId = document.lineCount - 1;
-  return new vscode.Range(
-    0,
-    0,
-    lastLineId,
-    document.lineAt(lastLineId).text.length
-  );
+  return new vscode.Range(0, 0, lastLineId, document.lineAt(lastLineId).text.length);
 }
 
 export { WorkspaceConfiguration, FormattingOptions } from "vscode";
@@ -23,52 +18,50 @@ export function getFormattedText(
   options: vscode.FormattingOptions
 ): string {
   try {
-    let formattingOptions: IOptions = <any>Object.assign({}, config);
+    let formattingOptions: IOptions = {};
 
-    // maxLength support has been removed and the following prevents
-    // old settings from using it
-    formattingOptions.maxLength = null;
+    if (config.configFile != null) {
+      formattingOptions.configFile = substituteVariables(config.configFile);
+      addToOutput(`Note: Since the \`pgFormatter.configFile\` setting was specified, all other settings will be ignored.`);
+    } else {
+      let formattingOptions: IOptions = <any>Object.assign({}, config);
 
-    // Convert option strings to enums
-    if (config.functionCase != null) {
-      formattingOptions.functionCase =
-        CaseOptionEnum[<keyof typeof CaseOptionEnum>config.functionCase];
-    }
-    if (config.keywordCase != null) {
-      formattingOptions.keywordCase =
-        CaseOptionEnum[<keyof typeof CaseOptionEnum>config.keywordCase];
-    }
+      // maxLength support has been removed and the following prevents
+      // old settings from using it
+      formattingOptions.maxLength = null;
 
-    if (!formattingOptions.spaces) {
-      if (options.tabSize) {
-        // If spaces config not specified, use the FormattingOptions value from VSCode workspace
-        formattingOptions.spaces = Number(options.tabSize);
+      // Convert option strings to enums
+      if (config.functionCase != null) {
+        formattingOptions.functionCase = CaseOptionEnum[<keyof typeof CaseOptionEnum>config.functionCase];
+      }
+      if (config.keywordCase != null) {
+        formattingOptions.keywordCase = CaseOptionEnum[<keyof typeof CaseOptionEnum>config.keywordCase];
       }
 
-      if (formattingOptions.tabs === undefined) {
-        // Neither spaces nor tabs option is configured; use insertSpaces to determine if we want to use tabs
-        formattingOptions.tabs = options.insertSpaces === false;
+      if (!formattingOptions.spaces) {
+        if (options.tabSize) {
+          // If spaces config not specified, use the FormattingOptions value from VSCode workspace
+          formattingOptions.spaces = Number(options.tabSize);
+        }
+
+        if (formattingOptions.tabs === undefined) {
+          // Neither spaces nor tabs option is configured; use insertSpaces to determine if we want to use tabs
+          formattingOptions.tabs = options.insertSpaces === false;
+        }
       }
-    }
 
-    if (config.configFile != null) {
-      formattingOptions.configFile = substituteVariables(config.configFile);
-    }
-    if (config.perlBinPath != null) {
-      formattingOptions.perlBinPath = substituteVariables(config.perlBinPath);
-    }
-    if (config.pgFormatterPath != null) {
-      formattingOptions.pgFormatterPath = substituteVariables(
-        config.pgFormatterPath
-      );
-    }
-    if (config.extraFunction != null) {
-      formattingOptions.extraFunction = substituteVariables(config.extraFunction);
+      if (config.perlBinPath != null) {
+        formattingOptions.perlBinPath = substituteVariables(config.perlBinPath);
+      }
+      if (config.pgFormatterPath != null) {
+        formattingOptions.pgFormatterPath = substituteVariables(config.pgFormatterPath);
+      }
+      if (config.extraFunction != null) {
+        formattingOptions.extraFunction = substituteVariables(config.extraFunction);
+      }
     }
 
-    addToOutput(
-      `Formatting with options ${JSON.stringify(formattingOptions)}:`
-    );
+    addToOutput(`Formatting with options ${JSON.stringify(formattingOptions)}:`);
     let formatted = formatSql(text, formattingOptions);
     return formatted;
   } catch (err) {
@@ -103,17 +96,12 @@ export async function provideDocumentFormattingEdits(
       // check for ignore text
 
       const text = document.getText();
-      let config = vscode.workspace.getConfiguration(
-        "pgFormatter",
-        vscode.window.activeTextEditor.document.uri
-      );
+      let config = vscode.workspace.getConfiguration("pgFormatter", vscode.window.activeTextEditor.document.uri);
 
       let formattedText = getFormattedText(text, config, options);
       if (formattedText && formattedText.length > 0) {
         // Do not replace if formatted is empty
-        edits.push(
-          vscode.TextEdit.replace(fullDocumentRange(document), formattedText)
-        );
+        edits.push(vscode.TextEdit.replace(fullDocumentRange(document), formattedText));
       }
     }
   }