Plugins Add sorting options for Organize References (#672)

Resolves #665

This commit adds options for sorting references:

- 'marker_order': List in order of appearance in document
- 'alphabetical': Alphabetical based on reference name, sorting
                  numerals lexagraphically
- 'numeric': Alphabetical based on reference name, sorting numeral
             chunks numerically

Author: DeathAxe

Preferences.sublime-settings

@@ -40,6 +40,16 @@
 	// Adds <Tab> after list items instead of a single <space>.
 	"mde.list_align_text": false,
 
+	// MarkdownEditing (References):
+	// The sorting method used by the Organize References command.
+	// Should be one of
+	//
+	// "reference_order": List in order of appearance in document
+	// "alphabetical": Alphabetical based on reference name, sorting numerals lexagraphically
+	// "numeric": Alphabetical based on reference name, sorting numeral chunks numerically
+	"mde.ref_organize_sort": "reference_order",
+	"mde.ref_organize_sort_reverse": false,
+
 	// MarkdownEditing:
 	// Automatically switches list bullet when indenting blank list item with <Tab>.
 	"mde.list_indent_auto_switch_bullet": true,

messages/3.1.1.md

@@ -21,6 +21,8 @@ feedback you can use [GitHub issues][issues].
 
 ## New Features
 
+* `Organize References` learned to sort reference definitions using `"mde.ref_organize_sort"` setting
+
 ## Changes
 
 * Fully support xonsh fenced code instead of using Python syntax 

plugins/references.py

@@ -551,10 +551,10 @@ def run(self, edit):
 
         # reorder
         markers = getMarkers(view)
-        marker_order = sorted(
+        reference_order = sorted(
             markers.keys(), key=lambda marker: min(markers[marker].regions, key=lambda reg: reg.a).a
         )
-        marker_order = dict(zip(marker_order, range(0, len(marker_order))))
+        reference_order = dict(zip(reference_order, range(0, len(reference_order))))
 
         refs = getReferences(view)
         flatrefs = []
@@ -570,9 +570,21 @@ def run(self, edit):
                     flatrefs.append((name, view.substr(line_reg).strip("\n")))
                 sel.add(line_reg)
 
+        sorting_funcs = {
+            "reference_order": lambda x: reference_order[x[0].lower()]
+            if x[0].lower() in reference_order
+            else 9999,
+            "alphabetical": lambda x: x[0].lower(),
+            "numeric": lambda x: [
+                int(p) if p.isnumeric() else p for p in re.split(r"[ _.-]", x[0].lower())
+            ],
+        }
+        settings = view.settings()
+
         flatfns.sort(key=operator.itemgetter(0))
         flatrefs.sort(
-            key=lambda x: marker_order[x[0].lower()] if x[0].lower() in marker_order else 9999
+            key=sorting_funcs[settings.get("mde.ref_organize_sort", "reference_order")],
+            reverse=settings.get("mde.ref_organize_sort_reverse", False),
         )
 
         view.run_command("left_delete")
@@ -627,7 +639,7 @@ def run(self, edit):
         lower_refs = [ref.lower() for ref in refs]
         missings = []
         for ref in refs:
-            if ref not in marker_order:
+            if ref not in reference_order:
                 missings.append(refs[ref].label)
         if len(missings) > 0:
             if len(missings) > 1: