Only send yaml files to the formatter (#231)

Author: kddejong

server/src/cfnServerInit.ts

@@ -20,7 +20,7 @@ import { SettingsState } from './cfnSettings';
 import { ValidationHandler } from './handlers/validationHandler';
 import { SettingsHandler } from './handlers/settingsHandler';
 import { NotificationHandler } from './handlers/notificationHandler';
-import { LanguageHandlers } from 'yaml-language-server/out/server/src/languageserver/handlers/languageHandlers';
+import { LanguageHandlers } from './handlers/languageHandlers';
 import { Telemetry } from 'yaml-language-server/out/server/src/languageserver/telemetry';
 import { readFile } from 'fs';
 import { JSONSchema } from 'yaml-language-server/out/server/src/languageservice/jsonSchema';

server/src/handlers/helpers.ts

@@ -0,0 +1,29 @@
+import { Connection } from 'vscode-languageserver';
+
+export function isCloudFormation(template: string, filename: string, cfnConnection: Connection): Boolean {
+
+	if (/"?AWSTemplateFormatVersion"?\s*/.exec(template)) {
+		cfnConnection.console.log("Determined this file is a CloudFormation Template. " + filename +
+			". Found the string AWSTemplateFormatVersion");
+		return true;
+	}
+	if (/\n?"?Resources"?\s*:/.exec(template)) {
+		if (/"?Type"?\s*:\s*"?'?[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}/.exec(template)) {
+			// filter out serverless.io templates
+			if (!(/\nresources:/.exec(template) && /\nprovider:/.exec(template))) {
+				cfnConnection.console.log("Determined this file is a CloudFormation Template. " + filename +
+					". Found 'Resources' and 'Type: [a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}'");
+				return true;
+			}
+		}
+	}
+	return false;
+}
+
+export function isYaml(filename: string): Boolean {
+
+	if (filename.endsWith('.yaml') || filename.endsWith('.yml')) {
+		return true;
+	}
+ 	return false;
+}

server/src/handlers/languageHandlers.ts

@@ -16,14 +16,17 @@ permissions and limitations under the License.
 import { Connection } from 'vscode-languageserver';
 import {
   TextDocumentPositionParams,
+  DocumentFormattingParams,
 } from 'vscode-languageserver-protocol';
 import {
   CompletionList,
+  TextEdit,
 } from 'vscode-languageserver-types';
 import { LanguageService } from 'yaml-language-server';
 import { SettingsState } from '../cfnSettings';
 import { ValidationHandler } from './validationHandler';
 import { LanguageHandlers as YamlLanguageHandlers } from 'yaml-language-server/out/server/src/languageserver/handlers/languageHandlers';
+import { isYaml } from './helpers';
 
 // code adopted from https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageserver/handlers/languageHandlers.ts
 export class LanguageHandlers extends YamlLanguageHandlers{
@@ -65,4 +68,33 @@ export class LanguageHandlers extends YamlLanguageHandlers{
       false,
     );
   }
+
+  /**
+   * Called when the formatter is invoked
+   * Returns the formatted document content using prettier
+   */
+   formatterHandler(formatParams: DocumentFormattingParams): TextEdit[] {
+    const uri = formatParams.textDocument.uri;
+    const document = this.cfnSettings.documents.get(uri);
+
+    if (!document) {
+      // @ts-ignore
+      return;
+    }
+
+    let fileIsYaml = isYaml(uri.toString());
+
+    if (!fileIsYaml) {
+      // @ts-ignore
+      return;
+    }
+
+    const customFormatterSettings = {
+      tabWidth: formatParams.options.tabSize,
+      ...this.cfnSettings.yamlFormatterSettings,
+    };
+
+    return this.cfnLanguageService.doFormat(document, customFormatterSettings);
+  }
+
 }

server/src/handlers/validationHandler.ts

@@ -23,7 +23,7 @@ import { CfnLint } from '../services/cfnlint';
 import { Diagnostic } from 'vscode-languageserver-types';
 import { LanguageService } from 'yaml-language-server';
 import { ValidationHandler as YamlValidationHandler } from 'yaml-language-server/out/server/src/languageserver/handlers/validationHandlers';
-
+import { isCloudFormation } from './helpers';
 
 // code adopted from https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageserver/handlers/validationHandlers.ts
 export class ValidationHandler extends YamlValidationHandler {
@@ -43,26 +43,6 @@ export class ValidationHandler extends YamlValidationHandler {
     });
   }
 
-  private isCloudFormation(template: string, filename: string): Boolean {
-
-    if (/"?AWSTemplateFormatVersion"?\s*/.exec(template)) {
-      this.cfnConnection.console.log("Determined this file is a CloudFormation Template. " + filename +
-        ". Found the string AWSTemplateFormatVersion");
-      return true;
-    }
-    if (/\n?"?Resources"?\s*:/.exec(template)) {
-      if (/"?Type"?\s*:\s*"?'?[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}/.exec(template)) {
-        // filter out serverless.io templates
-        if (!(/\nresources:/.exec(template) && /\nprovider:/.exec(template))) {
-          this.cfnConnection.console.log("Determined this file is a CloudFormation Template. " + filename +
-            ". Found 'Resources' and 'Type: [a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}'");
-          return true;
-        }
-      }
-    }
-    return false;
-  }
-
   private patchTemplateSchema(registrySchemaDirectory: string) {
     const stub = readFileSync(__dirname + '/../../schema/resource-patch-stub.json', 'utf8');
     let templateSchema = JSON.parse(readFileSync(__dirname + '/../../schema/all-spec.json', 'utf8'));
@@ -85,7 +65,7 @@ export class ValidationHandler extends YamlValidationHandler {
 
     let fileToLint = URI.parse(uri).fsPath;
 
-    let isCfn = this.isCloudFormation(document.getText(), uri.toString());
+    let isCfn = isCloudFormation(document.getText(), uri.toString(), this.cfnConnection);
 
     this.cfnConnection.sendNotification('cfn/isPreviewable', isCfn);