-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #685 from bweis/sorting
Added feature to order XML attributes by key alphabetically while prioritizing xmlns attributes
- Loading branch information
Showing
8 changed files
with
434 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /** | ||
| * An attribute object. | ||
| * @typedef {Object} Attribute | ||
| * @property {Object} node - Indicates the value of the attribute returned from prettier/doc. | ||
| * @property {String[]} printed - Indicates the printed format of the attribute. | ||
| */ | ||
|
|
||
| /** | ||
| * | ||
| * @param {Array} attributes | ||
| * @returns {Array} a copy of attributes that has been sorted | ||
| * | ||
| * <p> This is complicated because we need to parse the xmlns out of the | ||
| * attribute keys, prioritize xmlns attributes first, and then order | ||
| * accordingly. This is because I would like to extend this in the future to | ||
| * prioritize certain keys within certain namespaces. | ||
| */ | ||
| function sortAttributes(attributes) { | ||
| attributes.sort((leftAttr, rightAttr) => { | ||
| const leftToken = leftAttr.node.children.Name[0].image; | ||
| const rightToken = rightAttr.node.children.Name[0].image; | ||
| // Handle the highest priority attribute | ||
| if (isXmlns(leftToken)) { | ||
| return -1; // param1 appears earlier when sorted | ||
| } else if (isXmlns(rightToken)) { | ||
| return 1; // param1 appears later when sorted | ||
| } | ||
|
|
||
| if (containsNamespace(leftToken) && containsNamespace(rightToken)) { | ||
| return compareTwoNamespacedAttributeKeys(leftToken, rightToken); | ||
| } | ||
| // Handle the 1 but not both containing a namespace | ||
| if (containsNamespace(leftToken) && !containsNamespace(rightToken)) { | ||
| return -1; // key1 appears earlier when sorted | ||
| } else if (!containsNamespace(leftToken) && containsNamespace(rightToken)) { | ||
| return 1; // key1 appears later when sorted | ||
| } | ||
| return standardComparison(leftToken, rightToken); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {String} leftKey | ||
| * @param {String} rightKey | ||
| * @returns {Number} a comparison value | ||
| */ | ||
| function compareTwoNamespacedAttributeKeys(leftKey, rightKey) { | ||
| const [ns1, k1] = leftKey.split(":"); | ||
| const [ns2, k2] = rightKey.split(":"); | ||
| // if namespaces are equal, simply compare keys | ||
| if (ns1 === ns2) { | ||
| return standardComparison(k1, k2); | ||
| } | ||
| // Handle the 1 but not both being an xmlns | ||
| if (isXmlns(ns1) && !isXmlns(ns2)) { | ||
| return -1; // key1 appears earlier when sorted | ||
| } else if (!isXmlns(ns1) && isXmlns(ns2)) { | ||
| return 1; // key1 appears later when sorted | ||
| } | ||
| return standardComparison(ns1, ns2); | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {String} key | ||
| * @returns {Boolean} whether or not that key is namespace-d | ||
| */ | ||
| function containsNamespace(key) { | ||
| return key.includes(":"); | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {String} value | ||
| * @returns {Boolean} whether or not that value is xmlns | ||
| */ | ||
| function isXmlns(value) { | ||
| return value === "xmlns"; | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {String} key1 | ||
| * @param {String} key2 | ||
| * @returns {Number} a comparison value | ||
| */ | ||
| function standardComparison(key1, key2) { | ||
| if (key1 < key2) { | ||
| return -1; // param1 appears earlier when sorted | ||
| } else if (key1 > key2) { | ||
| return 1; // param1 appears later when sorted | ||
| } else { | ||
| return 0; | ||
| } | ||
| } | ||
|
|
||
| export default sortAttributes; |
Oops, something went wrong.