Attributes in newline threshold setting added (#149)

pmahend1 · Feb 25, 2024 · fc55ec8 · fc55ec8
1 parent b3b0247
commit fc55ec8
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Stable
 
+## 4.4.0: 25-Feb-2024
+
+- **Attributes In Newline Threshold** setting added.
+
 ## 4.3.0: 23-Feb-2024
 
 - Fixed some CDATA and text formatting.

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.3.0",
+    "version": "4.4.0",
     "publisher": "PrateekMahendrakar",
     "repository": {
         "url": "https://github.com/pmahend1/prettyxml.git"
@@ -173,6 +173,22 @@
                         "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.attributesInNewlineThreshold": {
+                        "type": "number",
+                        "default": 1,
+                        "enum": [
+                            1,
+                            2,
+                            3,
+                            4,
+                            5,
+                            6,
+                            7,
+                            8,
+                            9
+                        ],
+                        "markdownDescription": "Attributes count threshold to position attributes in newlines. Default is *1*. This setting only works when **Position first attribute on same line** is enabled.\n\nFor example if threshold=2, all attributes will be on same line if an element has only 2 attributes,\n\notherwise each attribute will be placed on newline."
+                    },
                     "prettyxml.settings.enableLogs": {
                         "type": "boolean",
                         "markdownDescription": "Enable console local logs.",

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

diff --git a/src/settings.ts b/src/settings.ts
@@ -11,6 +11,7 @@ export interface ISettings {
     positionAllAttributesOnFirstLine: boolean;
     preserveWhiteSpacesInComment: boolean;
     addSpaceBeforeEndOfXmlDeclaration: boolean;
+    attributesInNewlineThreshold: number;
     enableLogs: boolean;
 }
 
@@ -27,6 +28,7 @@ export const defaultSettings: ISettings = {
     positionAllAttributesOnFirstLine: false,
     preserveWhiteSpacesInComment: false,
     addSpaceBeforeEndOfXmlDeclaration: false,
+    attributesInNewlineThreshold: 1,
     enableLogs: false
 };
 
@@ -43,6 +45,7 @@ export class Settings {
     positionAllAttributesOnFirstLine?: boolean;
     preserveWhiteSpacesInComment?: boolean;
     addSpaceBeforeEndOfXmlDeclaration: boolean;
+    attributesInNewlineThreshold: number;
     enableLogs?: boolean;
 
     constructor(indentLengh?: number,
@@ -57,6 +60,7 @@ export class Settings {
         positionAllAttributesOnFirstLine?: boolean,
         preserveWhiteSpacesInComment?: boolean,
         addSpaceBeforeEndOfXmlDeclaration?: boolean,
+        attributesInNewlineThreshold?: number,
         enableLogs?: boolean) {
         this.indentLength = indentLengh ?? defaultSettings.indentLength;
         this.useSingleQuotes = useSingleQuotes ?? defaultSettings.useSingleQuotes;
@@ -70,6 +74,7 @@ export class Settings {
         this.positionAllAttributesOnFirstLine = positionAllAttributesOnFirstLine ?? defaultSettings.positionAllAttributesOnFirstLine;
         this.preserveWhiteSpacesInComment = preserveWhiteSpacesInComment ?? defaultSettings.preserveWhiteSpacesInComment;
         this.addSpaceBeforeEndOfXmlDeclaration = addSpaceBeforeEndOfXmlDeclaration ?? defaultSettings.addSpaceBeforeEndOfXmlDeclaration;
+        this.attributesInNewlineThreshold = attributesInNewlineThreshold ?? defaultSettings.attributesInNewlineThreshold;
         this.enableLogs = enableLogs ?? defaultSettings.enableLogs;
     }
 }