Added space in xml declaration end setting (#145)

pmahend1 · Feb 5, 2024 · c5265c4 · c5265c4
1 parent 5f45dec
commit c5265c4
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Stable
 
+### 4.2.0: 04-Feb-2024
+
+- Added setting `addSpaceBeforeEndOfXmlDeclaration`
+
 ### 4.1.3: 03-Feb-2024
 
 - Fix for [#141: Some comments are lost after format](https://github.com/pmahend1/PrettyXML/issues/141).

diff --git a/README.md b/README.md
@@ -116,7 +116,8 @@ These will be for **Prettify XML** command.
 | prettyxml.settings.allowWhiteSpaceUnicodesInAttributeValues | true          | Allows white space unicodes in attribute values |
 | prettyxml.settings.positionFirstAttributeOnSameLine         | true          | Position first attribute on same line.          |
 | prettyxml.settings.positionAllAttributesOnFirstLine         | false         | Position all attributes on first line           |
-| prettyxml.settings.preserveWhiteSpacesInComment             | false         | Preserves whitespaces in a comment             |
+| prettyxml.settings.preserveWhiteSpacesInComment             | false         | Preserves whitespaces in a comment              |
+| prettyxml.settings.addSpaceBeforeEndOfXmlDeclaration        | false         | Add space before end of XML declaration         |
 | prettyxml.settings.enableLogs                               | false         | Enables logs                                    |
 
 ![Settings Image.](./images/settings.png)

diff --git a/images/settings.png b/images/settings.png
diff --git a/lib/XmlFormatter.CommandLine.dll b/lib/XmlFormatter.CommandLine.dll
diff --git a/lib/XmlFormatter.CommandLine.exe b/lib/XmlFormatter.CommandLine.exe
diff --git a/lib/XmlFormatter.CommandLine.pdb b/lib/XmlFormatter.CommandLine.pdb
diff --git a/lib/XmlFormatter.dll b/lib/XmlFormatter.dll
diff --git a/lib/XmlFormatter.pdb b/lib/XmlFormatter.pdb
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     },
     "readme": "https://github.com/pmahend1/PrettyXML/blob/main/README.md",
     "description": "XML formatter extension for Visual Studio Code. Formats XML documents just like Visual Studio.",
-    "version": "4.1.3",
+    "version": "4.2.0",
     "publisher": "PrateekMahendrakar",
     "repository": {
         "url": "https://github.com/pmahend1/prettyxml.git"
@@ -168,6 +168,11 @@
                         "markdownDescription": "Preserves whitespaces in comment. Setting this *Checked* ignores *Wrap Comment Text With Spaces* setting. Default is *Unchecked* \n\n **Checked** : \n\n `<!--`&ensp;&ensp;&ensp;&ensp;`Comment`&ensp;&ensp;&ensp;&ensp;`-->` \n\n **Unchecked** : \n\n `<!--Comment-->`",
                         "default": false
                     },
+                    "prettyxml.settings.addSpaceBeforeEndOfXmlDeclaration": {
+                        "type": "boolean",
+                        "markdownDescription": "Adds space before end of XML declaration. Default is *Unchecked* \n\n **Checked** : \n\n `<?xml version=\"1.0\" encoding=\"utf-8\" ?>` \n\n **Unchecked** : \n\n `<?xml version=\"1.0\" encoding=\"utf-8\"?>`",
+                        "default": false
+                    },
                     "prettyxml.settings.enableLogs": {
                         "type": "boolean",
                         "markdownDescription": "Enable console local logs.",

diff --git a/src/formatter.ts b/src/formatter.ts
@@ -56,8 +56,10 @@ export class Formatter {
         let positionFirstAttributeOnSameLine = prettyXmlConfig.get<boolean>('positionFirstAttributeOnSameLine');
         let positionAllAttributesOnFirstLine = prettyXmlConfig.get<boolean>('positionAllAttributesOnFirstLine');
         let preserveWhiteSpacesInComment = prettyXmlConfig.get<boolean>('preserveWhiteSpacesInComment');
+        let addSpaceBeforeEndOfXmlDeclaration = prettyXmlConfig.get<boolean>('addSpaceBeforeEndOfXmlDeclaration');
         let enableLogs = prettyXmlConfig.get<boolean>('enableLogs');
-
+        Logger.instance.updateConfiguration(enableLogs);
+
         this.settings = new Settings(spacelength,
             usesinglequotes,
             useselfclosetag,
@@ -69,9 +71,11 @@ export class Formatter {
             positionFirstAttributeOnSameLine,
             positionAllAttributesOnFirstLine,
             preserveWhiteSpacesInComment,
+            addSpaceBeforeEndOfXmlDeclaration,
             enableLogs);
 
-        Logger.instance.updateConfiguration(enableLogs);
+        Logger.instance.info(`Settings : ${JSON.stringify(this.settings)}`);
+
         Logger.instance.info("loadSettings end");
     }
 

diff --git a/src/settings.ts b/src/settings.ts
@@ -10,6 +10,7 @@ export interface ISettings {
     positionFirstAttributeOnSameLine: boolean;
     positionAllAttributesOnFirstLine: boolean;
     preserveWhiteSpacesInComment: boolean;
+    addSpaceBeforeEndOfXmlDeclaration: boolean;
     enableLogs: boolean;
 }
 
@@ -25,6 +26,7 @@ export const defaultSettings: ISettings = {
     positionFirstAttributeOnSameLine: true,
     positionAllAttributesOnFirstLine: false,
     preserveWhiteSpacesInComment: false,
+    addSpaceBeforeEndOfXmlDeclaration: false,
     enableLogs: false
 };
 
@@ -40,9 +42,10 @@ export class Settings {
     positionFirstAttributeOnSameLine?: boolean;
     positionAllAttributesOnFirstLine?: boolean;
     preserveWhiteSpacesInComment?: boolean;
+    addSpaceBeforeEndOfXmlDeclaration: boolean;
     enableLogs?: boolean;
 
-    constructor(indentLengh?: number, 
+    constructor(indentLengh?: number,
         useSingleQuotes?: boolean,
         useSelfClosingTags?: boolean,
         formatOnSave?: boolean,
@@ -53,6 +56,7 @@ export class Settings {
         positionFirstAttributeOnSameLine?: boolean,
         positionAllAttributesOnFirstLine?: boolean,
         preserveWhiteSpacesInComment?: boolean,
+        addSpaceBeforeEndOfXmlDeclaration?: boolean,
         enableLogs?: boolean) {
         this.indentLength = indentLengh ?? defaultSettings.indentLength;
         this.useSingleQuotes = useSingleQuotes ?? defaultSettings.useSingleQuotes;
@@ -65,6 +69,7 @@ export class Settings {
         this.positionFirstAttributeOnSameLine = positionFirstAttributeOnSameLine ?? defaultSettings.positionFirstAttributeOnSameLine;
         this.positionAllAttributesOnFirstLine = positionAllAttributesOnFirstLine ?? defaultSettings.positionAllAttributesOnFirstLine;
         this.preserveWhiteSpacesInComment = preserveWhiteSpacesInComment ?? defaultSettings.preserveWhiteSpacesInComment;
+        this.addSpaceBeforeEndOfXmlDeclaration = addSpaceBeforeEndOfXmlDeclaration ?? defaultSettings.addSpaceBeforeEndOfXmlDeclaration;
         this.enableLogs = enableLogs ?? defaultSettings.enableLogs;
     }
 }