feat: contribute configuration for natural sorting

1nVitr0 · Jun 14, 2021 · 0b61216 · 0b61216
1 parent a2bf771
commit 0b61216
Show file tree

Hide file tree

Showing 7 changed files with 111 additions and 32 deletions.
diff --git a/package.json b/package.json
@@ -120,6 +120,44 @@
               }
             }
           },
+          "blocksort.enableNaturalSorting": {
+            "type": "boolean",
+            "description": "Sort string containing numbers intuitively (`80` before `443`)",
+            "default": false
+          },
+          "blocksort.naturalSorting": {
+            "type": "object",
+            "description": "Settings for natural sorting",
+            "default": {
+              "enabled": false,
+              "padding": 9,
+              "omitUuids": false,
+              "sortNegativeValues": true
+            },
+            "required": [
+              "enabled"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "padding": {
+                "description": "For natural sorting numbers are padded with 0. For performance reasons the number of 0s is fixed to this value",
+                "default": 9,
+                "type": "number",
+                "minimum": "0",
+                "maximum": "16"
+              },
+              "omitUuids": {
+                "description": "Enables very basic UUID detection and automatically disables natural sorting for these values.  Might still fail for edge cases (like a number at the end of the UUID or on dashes)",
+                "default": false,
+                "type": "boolean"
+              },
+              "sortNegativeValues": {
+                "description": "Sort negative values before positive. Might fail, especially on UUIDs containing dashes",
+                "default": true,
+                "type": "boolean"
+              }
+            }
+          },
           "blocksort.sortConsecutiveBlockHeaders": {
             "description": "sort consecutive block headers (such as case or when)",
             "type": "boolean",

diff --git a/src/commands/blockSort.ts b/src/commands/blockSort.ts
@@ -39,17 +39,21 @@ function blockSortMultilevel(sortFunction: (a: string, b: string) => number) {
 }
 
 export function blockSortAsc(editor: TextEditor, editBuilder: TextEditorEdit) {
-  blockSort(editor, editBuilder, BlockSortProvider.sort.asc);
+  const naturalSorting = ConfigurationProvider.getEnableNaturalSorting();
+  blockSort(editor, editBuilder, naturalSorting ? BlockSortProvider.sort.ascNatural : BlockSortProvider.sort.asc);
 }
 
 export function blockSortDesc(editor: TextEditor, editBuilder: TextEditorEdit) {
-  blockSort(editor, editBuilder, BlockSortProvider.sort.desc);
+  const naturalSorting = ConfigurationProvider.getEnableNaturalSorting();
+  blockSort(editor, editBuilder, naturalSorting ? BlockSortProvider.sort.descNatural : BlockSortProvider.sort.desc);
 }
 
 export function blockSortMultilevelAsc() {
-  blockSortMultilevel(BlockSortProvider.sort.asc);
+  const naturalSorting = ConfigurationProvider.getEnableNaturalSorting();
+  blockSortMultilevel(naturalSorting ? BlockSortProvider.sort.ascNatural : BlockSortProvider.sort.asc);
 }
 
 export function blockSortMultilevelDesc() {
-  blockSortMultilevel(BlockSortProvider.sort.desc);
+  const naturalSorting = ConfigurationProvider.getEnableNaturalSorting();
+  blockSortMultilevel(naturalSorting ? BlockSortProvider.sort.descNatural : BlockSortProvider.sort.desc);
 }
diff --git a/src/providers/BlockSortProvider.ts b/src/providers/BlockSortProvider.ts
@@ -13,16 +13,15 @@ export default class BlockSortProvider {
       BlockSortProvider.sort.desc(BlockSortProvider.padNumbers(a), BlockSortProvider.padNumbers(b)),
   };
   protected static padNumbers(line: string) {
-    const pad = /*naturalSortPadding*/ 16;
+    const { omitUuids, padding, sortNegativeValues } = ConfigurationProvider.getNaturalSortOptions();
     let result = line;
-    if (/*detectUuids*/ true)
-      result = result.replace(/\d+(?=[^a-zA-z]|$)|(?<=[^a-zA-z]|^)\d+/g, (match) => match.padStart(pad, "0"));
-    else result = result.replace(/\d+/g, (match) => match.padStart(pad, "0"));
+    if (omitUuids) result = result.replace(/\d+(?=[^a-zA-z]|$)|(?<=[^a-zA-z]|^)\d+/g, (match) => match.padStart(padding, "0"));
+    else result = result.replace(/\d+/g, (match) => match.padStart(padding, "0"));
 
-    if (/*negative values*/ true) {
+    if (sortNegativeValues) {
       result = result.replace(
-        new RegExp(`-\\d{${pad}}`, "g"),
-        (match) => `-${(Math.pow(10, pad) + parseInt(match)).toString()}`
+        new RegExp(`-\\d{${padding}}`, "g"),
+        (match) => `-${(Math.pow(10, padding) + parseInt(match)).toString()}`
       );
     }
 

diff --git a/src/providers/ConfigurationProvider.ts b/src/providers/ConfigurationProvider.ts
@@ -1,68 +1,90 @@
-import { workspace } from 'vscode';
-import { FoldingMarkerDefault, FoldingMarkerList } from './StringProcessingProvider';
+import { workspace } from "vscode";
+import { FoldingMarkerDefault, FoldingMarkerList } from "./StringProcessingProvider";
 
 const defaultFoldingMarkers: FoldingMarkerList<FoldingMarkerDefault> = {
-  '()': { start: '\\(', end: '\\)' },
-  '[]': { start: '\\[', end: '\\]' },
-  '{}': { start: '\\{', end: '\\}' },
-  '<>': { start: '<[a-zA-Z0-9\\-_=\\s]+', end: '<\\/[a-zA-Z0-9\\-_=\\s]+' },
+  "()": { start: "\\(", end: "\\)" },
+  "[]": { start: "\\[", end: "\\]" },
+  "{}": { start: "\\{", end: "\\}" },
+  "<>": { start: "<[a-zA-Z0-9\\-_=\\s]+", end: "<\\/[a-zA-Z0-9\\-_=\\s]+" },
 };
 
-const defaultCompleteBlockMarkers = ['\\}', '<\\/[a-zA-Z0-9\\-_=\\s]+'];
+const defaultCompleteBlockMarkers = ["\\}", "<\\/[a-zA-Z0-9\\-_=\\s]+"];
 
 const defaultIndentIgnoreMarkers = [
-  '{',
+  "{",
   // eslint-disable-next-line quotes
   "end(?:for(?:each)?|if|while|case|def)?\\s*?([\\.\\[\\->\\|\\s]\\s*(?:[$A-Za-z0-9_+\\-\\*\\/\\^\\%\\<\\>\\=\\!\\?\\:]*|'[^']*?'|'[']*?'|\"[^\"]*?\"|`[^`]*?`)\\s*[\\]\\|]?\\s*)*",
-  'esac|fi',
+  "esac|fi",
 ];
 
+export interface NaturalSortOptions {
+  enabled: boolean;
+  padding: number;
+  omitUuids: boolean;
+  sortNegativeValues: boolean;
+}
+
 export default class ConfigurationProvider {
   public static getFoldingMarkers(): FoldingMarkerList {
-    const additional: FoldingMarkerList = workspace.getConfiguration('blocksort').get('foldingMarkers') || {};
+    const additional: FoldingMarkerList = workspace.getConfiguration("blocksort").get("foldingMarkers") || {};
     return { ...additional, ...defaultFoldingMarkers };
   }
 
   public static getCompleteBlockMarkers(): string[] {
-    const additional: string[] = workspace.getConfiguration('blocksort').get('completeBlockMarkers') || [];
+    const additional: string[] = workspace.getConfiguration("blocksort").get("completeBlockMarkers") || [];
     return [...additional, ...defaultCompleteBlockMarkers];
   }
 
   public static getSortConsecutiveBlockHeaders(): boolean {
     const configuration: boolean | undefined = workspace
-      .getConfiguration('blocksort')
-      .get('sortConsecutiveBlockHeaders');
+      .getConfiguration("blocksort")
+      .get("sortConsecutiveBlockHeaders");
     return configuration === undefined ? true : configuration;
   }
 
   public static getDefaultMultilevelDepth(): number {
-    const configuration: number | undefined = workspace.getConfiguration('blocksort').get('defaultMultilevelDepth');
+    const configuration: number | undefined = workspace.getConfiguration("blocksort").get("defaultMultilevelDepth");
     return configuration === undefined ? -1 : configuration;
   }
 
   public static getAskForMultilevelDepth(): boolean {
-    const configuration: boolean | undefined = workspace.getConfiguration('blocksort').get('askForMultilevelDepth');
+    const configuration: boolean | undefined = workspace.getConfiguration("blocksort").get("askForMultilevelDepth");
     return configuration === undefined ? true : configuration;
   }
 
   public static getForceBlockHeaderFirstRegex(): string {
-    return '$^';
+    return "$^";
   }
 
   public static getForceBlockHeaderLastRegex(): string {
-    return '(default|else)\\s*(\'([^\']|(?<=\\\\)\')*\'|"([^"]|(?<=\\\\)")*"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?(\r?\n|$)';
+    return "(default|else)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?(\r?\n|$)";
   }
 
   public static getMultiBlockHeaderRegex(): string {
-    return '(when|case|else|default)\\s*(\'([^\']|(?<=\\\\)\')*\'|"([^"]|(?<=\\\\)")*"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$';
+    return "(when|case|else|default)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$";
   }
 
   public static getIncompleteBlockRegex(): string {
-    return '(if|when|else|case|for|foreach|else|elsif|while|def|then)\\s*(\'([^\']|(?<=\\\\)\')*\'|"([^"]|(?<=\\\\)")*"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$';
+    return "(if|when|else|case|for|foreach|else|elsif|while|def|then)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$";
   }
 
   public static getIndentIgnoreMarkers(): string[] {
-    const additional: string[] = workspace.getConfiguration('blocksort').get('indentIgnoreMarkers') || [];
+    const additional: string[] = workspace.getConfiguration("blocksort").get("indentIgnoreMarkers") || [];
     return [...additional, ...defaultIndentIgnoreMarkers];
   }
+
+  public static getNaturalSortOptions(): NaturalSortOptions {
+    const configuration:  Partial<NaturalSortOptions> = workspace.getConfiguration("blocksort").get("naturalSorting") || {};
+    return {
+      enabled: false,
+      padding: 9,
+      omitUuids: false,
+      sortNegativeValues: true,
+      ...configuration
+    };
+  }
+
+  public static getEnableNaturalSorting(): boolean {
+    return !!workspace.getConfiguration("blocksort").get("enableNaturalSorting");
+  }
 }
diff --git a/src/test/fixtures/natural.ts b/src/test/fixtures/natural.ts
@@ -5,6 +5,6 @@ export const naturalSortTests: SortTest[] = [
   {
     file: 'natural.txt.fixture',
     compareFile: 'natural.txt.expect',
-    ranges: [new Range(0, 0, 4, 4), new Range(6, 0, 9, 9)],
+    ranges: [new Range(0, 0, 4, 4), new Range(6, 0, 9, 9), new Range(11, 0, 17, 5)],
   },
 ];
diff --git a/test/fixtures/natural.txt.expect b/test/fixtures/natural.txt.expect
@@ -8,3 +8,11 @@ port 22
 port 80
 port 443
 port 8080
+
+-3456
+-12
+2
+19
+60
+145
+1837
diff --git a/test/fixtures/natural.txt.fixture b/test/fixtures/natural.txt.fixture
@@ -8,3 +8,11 @@ port 443
 port 80
 port 8080
 port 22
+
+145
+2
+19
+-12
+1837
+60
+-3456
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,3 +8,11 @@ port 22 @@
     port 80
     port 443
     port 8080
+    -3456
+    -12