Merge pull request #17 from HugoOM/Fix_XMLSupportForAuraCmp

Fix: Added xml support for aura cmp

CHANGELOG.md

@@ -7,6 +7,10 @@
 - File header update regardless of settings (for header inserted through command)
 - Finer grain tuning of the method header tags through settings
 
+## [0.5.2]
+
+- Added support for XML language binding under Aura .cmp files
+
 ## [0.5.1]
 
 - Fixed an issue where two spaces would be added between a param type and it's name, for method headers

package.json

@@ -2,7 +2,7 @@
   "name": "sfdx-autoheader",
   "displayName": "Salesforce Documenter",
   "description": "Automated Code Documentation Generation for Salesforce",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "publisher": "HugoOM",
   "license": "MIT",
   "badges": [
@@ -42,7 +42,8 @@
     "onLanguage:apex",
     "onLanguage:visualforce",
     "onLanguage:javascript",
-    "onLanguage:html"
+    "onLanguage:html",
+    "onLanguage:xml"
   ],
   "main": "./out/documenter.js",
   "contributes": {
@@ -72,6 +73,11 @@
           "command": "extension.insertFileHeader",
           "group": "SFDoc",
           "when": "editorLangId == javascript"
+        },
+        {
+          "command": "extension.insertFileHeader",
+          "group": "SFDoc",
+          "when": "editorLangId == xml"
         }
       ],
       "commandPalette": [
@@ -99,6 +105,11 @@
           "command": "extension.insertFileHeader",
           "group": "SFDoc",
           "when": "editorLangId == javascript"
+        },
+        {
+          "command": "extension.insertFileHeader",
+          "group": "SFDoc",
+          "when": "editorLangId == xml"
         }
       ]
     },

src/extension/documenter.file.ts

@@ -58,6 +58,7 @@ export default class FileDocumenter {
     if (languageId === "visualforce") return true;
     if (languageId === "html") return true;
     if (languageId === "javascript") return true;
+    if (languageId === "xml") return true;
 
     return false;
   }
@@ -167,14 +168,17 @@ export default class FileDocumenter {
     if (lang === "html")
       return enabledForLightMarkup && this.isLightning(document);
 
+    if (lang === "xml")
+      return enabledForLightMarkup && this.isLightning(document);
+
     if (lang === "javascript")
       return enabledForLightningJavaScript && this.isLightning(document);
 
     return false;
   }
 
   private isLightning(document: TextDocument): boolean {
-    const validExtensions: string[] = ["htm", "html", "cmp", "js"];
+    const validExtensions: string[] = ["htm", "html", "cmp", "js", "xml"];
     const validSalesforceFolderNames = ["aura", "lwc"];
     const pathTokens = document.uri.path.split("/");
     const folderName = pathTokens[pathTokens.length - 2];

src/templates/templates.file.ts

@@ -44,6 +44,20 @@ module.exports = {
   ==============================================================================
   1.0    ${currentTime}   ${userName}     Initial Version
 -->
+`,
+  xml: (fileName: string, userName: string, currentTime: string) => `<!--
+  @Component Name     : ${fileName}
+  @Description        : 
+  @Author             : ${userName}
+  @Group              : 
+  @Last Modified By   : ${userName}
+  @Last Modified On   : ${currentTime}
+  @Modification Log   : 
+  ==============================================================================
+  Ver         Date                     Author      		      Modification
+  ==============================================================================
+  1.0    ${currentTime}   ${userName}     Initial Version
+-->
 `,
   javascript: (fileName: string, userName: string, currentTime: string) => `/**
  * @File Name          : ${fileName}