emacs: keep elpa/nongnu/melpa package overrides sorted

The first half of melpa-packages.nix is not kept sorted in this PR
because it is a bit tricky.  We will deal with it in the future.

pkgs/applications/editors/emacs/elisp-packages/elpa-common-overrides.nix

@@ -14,11 +14,7 @@ let
     ;
 in
 {
-  cl-lib = null; # builtin
+  # keep-sorted start block=yes newline_separated=yes
-  cl-print = null; # builtin
-  tle = null; # builtin
-  advice = null; # builtin
-
   # Compilation instructions for the Ada executables:
   # https://www.nongnu.org/ada-mode/
   ada-mode = super.ada-mode.overrideAttrs (
@@ -65,6 +61,8 @@ in
   # native-compiler-error-empty-byte in old versions
   ada-ref-man = ignoreCompilationErrorIfOlder super.ada-ref-man "2020.1.0.20201129.190419";
 
+  advice = null; # builtin
+
   # elisp error in old versions
   ampc = ignoreCompilationErrorIfOlder super.ampc "0.2.0.20240220.181558";
 
@@ -74,6 +72,10 @@ in
 
   auctex-label-numbers = mkHome super.auctex-label-numbers;
 
+  cl-lib = null; # builtin
+
+  cl-print = null; # builtin
+
   # missing optional dependencies https://codeberg.org/rahguzar/consult-hoogle/issues/4
   consult-hoogle = addPackageRequiresIfOlder super.consult-hoogle [ self.consult ] "0.2.2";
 
@@ -234,8 +236,6 @@ in
   # native-ice https://github.com/mattiase/relint/issues/15
   relint = ignoreCompilationError super.relint;
 
-  shen-mode = ignoreCompilationErrorIfOlder super.shen-mode "0.1.0.20221221.82050"; # elisp error
-
   # native compilation for tests/seq-tests.el never ends
   # delete tests/seq-tests.el to workaround this
   seq = super.seq.overrideAttrs (old: {
@@ -251,6 +251,8 @@ in
       '';
   });
 
+  shen-mode = ignoreCompilationErrorIfOlder super.shen-mode "0.1.0.20221221.82050"; # elisp error
+
   # https://github.com/alphapapa/taxy.el/issues/3
   taxy = super.taxy.overrideAttrs (old: {
     dontUnpack = false;
@@ -269,6 +271,8 @@ in
 
   timerfunctions = ignoreCompilationErrorIfOlder super.timerfunctions "1.4.2.0.20201129.225252";
 
+  tle = null; # builtin
+
   # kv is required in triples-test.el
   # Alternatively, we can delete that file.  But adding a dependency is easier.
   triples = addPackageRequires super.triples [ self.kv ];
@@ -295,4 +299,6 @@ in
 
   # native-ice https://github.com/mattiase/xr/issues/9
   xr = ignoreCompilationError super.xr;
+
+  # keep-sorted end
 }

pkgs/applications/editors/emacs/elisp-packages/elpa-devel-packages.nix

@@ -58,6 +58,8 @@ let
       commonOverrides = import ./elpa-common-overrides.nix pkgs lib buildPackages;
 
       overrides = self: super: {
+        # keep-sorted start block=yes newline_separated=yes
+        # keep-sorted end
       };
 
       elpaDevelPackages =

pkgs/applications/editors/emacs/elisp-packages/elpa-packages.nix

@@ -58,14 +58,16 @@ let
       commonOverrides = import ./elpa-common-overrides.nix pkgs lib buildPackages;
 
       overrides = self: super: {
+        # keep-sorted start block=yes newline_separated=yes
         # upstream issue: Wrong type argument: arrayp, nil
         org-transclusion =
           if super.org-transclusion.version == "1.2.0" then
             markBroken super.org-transclusion
           else
             super.org-transclusion;
-        rcirc-menu = markBroken super.rcirc-menu; # Missing file header
 
+        rcirc-menu = markBroken super.rcirc-menu; # Missing file header
+        # keep-sorted end
       };
 
       elpaPackages =

pkgs/applications/editors/emacs/elisp-packages/melpa-packages.nix

@@ -828,9 +828,12 @@ let
             else
               super.osx-dictionary;
 
+          # keep-sorted start block=yes newline_separated=yes
           # https://github.com/skeeto/at-el/issues/9
           "@" = ignoreCompilationErrorIfOlder super."@" "20240923.1318";
 
+          "git-gutter-fringe+" = ignoreCompilationError super."git-gutter-fringe+"; # elisp error
+
           abgaben = addPackageRequires (mkHome super.abgaben) [ self.mu4e ];
 
           # https://github.com/afroisalreadyinu/abl-mode/issues/9
@@ -882,14 +885,14 @@ let
 
           auctex-latexmk = mkHome super.auctex-latexmk;
 
-          auto-indent-mode = ignoreCompilationError super.auto-indent-mode; # elisp error
-
           # missing optional dependencies
           auto-complete-auctex = addPackageRequires (mkHome super.auto-complete-auctex) [ self.auctex ];
 
           # depends on distel which is not on any ELPA https://github.com/massemanet/distel/issues/21
           auto-complete-distel = ignoreCompilationError super.auto-complete-distel;
 
+          auto-indent-mode = ignoreCompilationError super.auto-indent-mode; # elisp error
+
           auto-virtualenv = super.auto-virtualenv.overrideAttrs (
             finalAttrs: previousAttrs: {
               patches = previousAttrs.patches or [ ] ++ [
@@ -1147,6 +1150,8 @@ let
           # missing optional dependencies
           ekg = addPackageRequires super.ekg [ self.denote ];
 
+          el-secretario-mu4e = addPackageRequires super.el-secretario-mu4e [ self.mu4e ];
+
           elfeed = super.elfeed.overrideAttrs (attrs: {
             postPatch =
               attrs.postPatch or ""
@@ -1170,16 +1175,15 @@ let
             ];
           });
 
-          el-secretario-mu4e = addPackageRequires super.el-secretario-mu4e [ self.mu4e ];
-
           embark-vc = buildWithGit super.embark-vc;
 
           # https://github.com/nubank/emidje/issues/23
           emidje = addPackageRequires super.emidje [ self.pkg-info ];
 
+          emms-player-mpv-jp-radios = ignoreCompilationError super.emms-player-mpv-jp-radios;
+
           # depends on later-do which is not on any ELPA
           emms-player-simple-mpv = ignoreCompilationError super.emms-player-simple-mpv;
-          emms-player-mpv-jp-radios = ignoreCompilationError super.emms-player-mpv-jp-radios;
 
           # missing optional dependencies
           # https://github.com/isamert/empv.el/pull/96
@@ -1273,8 +1277,6 @@ let
 
           gh-notify = buildWithGit super.gh-notify;
 
-          "git-gutter-fringe+" = ignoreCompilationError super."git-gutter-fringe+"; # elisp error
-
           # https://github.com/nlamirault/emacs-gitlab/issues/68
           gitlab = addPackageRequires super.gitlab [ self.f ];
 
@@ -1310,6 +1312,9 @@ let
 
           helm-ext = ignoreCompilationError super.helm-ext; # elisp error
 
+          # TODO report to upstream
+          helm-flycheck = fixRequireHelmCore super.helm-flycheck;
+
           # https://github.com/iory/emacs-helm-ghs/issues/1
           helm-ghs = addPackageRequires super.helm-ghs [ self.helm-ghq ];
 
@@ -1319,9 +1324,6 @@ let
             self.magit
           ];
 
-          # TODO report to upstream
-          helm-flycheck = fixRequireHelmCore super.helm-flycheck;
-
           # https://github.com/yasuyk/helm-git-grep/issues/54
           helm-git-grep = addPackageRequires super.helm-git-grep [ self.helm ];
 
@@ -1547,29 +1549,15 @@ let
 
           org-gtd = ignoreCompilationError super.org-gtd; # elisp error
 
+          # TODO report to upstream
+          org-kindle = addPackageRequires super.org-kindle [ self.dash ];
+
           # needs newer org than the Emacs 29.4 builtin one
           org-link-beautify = addPackageRequires super.org-link-beautify [
             self.org
             self.qrencode
           ];
 
-          # TODO report to upstream
-          org-kindle = addPackageRequires super.org-kindle [ self.dash ];
-
-          org-special-block-extras = ignoreCompilationError super.org-special-block-extras; # elisp error
-
-          # https://github.com/ichernyshovvv/org-timeblock/issues/65
-          org-timeblock = markBroken super.org-timeblock;
-
-          org-trello = ignoreCompilationError super.org-trello; # elisp error
-
-          # Requires xwidgets compiled into emacs, so mark this package
-          # as broken if emacs hasn't been compiled with the flag.
-          org-xlatex = if self.emacs.withXwidgets then super.org-xlatex else markBroken super.org-xlatex;
-
-          # Optimizer error: too much on the stack
-          orgnav = ignoreCompilationError super.orgnav;
-
           org-noter = super.org-noter.overrideAttrs (
             finalAttrs: previousAttrs: {
               patches =
@@ -1589,15 +1577,6 @@ let
 
           org-noter-pdftools = mkHome super.org-noter-pdftools;
 
-          # elisp error and missing optional dependencies
-          org-ref = ignoreCompilationError super.org-ref;
-
-          # missing optional dependencies
-          org-roam-bibtex = addPackageRequires super.org-roam-bibtex [
-            self.helm-bibtex
-            self.ivy-bibtex
-          ];
-
           org-pdftools = mkHome super.org-pdftools;
 
           org-projectile = super.org-projectile.overrideAttrs (
@@ -1617,6 +1596,29 @@ let
           # https://github.com/colonelpanic8/org-project-capture/issues/66
           org-projectile-helm = addPackageRequires super.org-projectile-helm [ self.helm-org ];
 
+          # elisp error and missing optional dependencies
+          org-ref = ignoreCompilationError super.org-ref;
+
+          # missing optional dependencies
+          org-roam-bibtex = addPackageRequires super.org-roam-bibtex [
+            self.helm-bibtex
+            self.ivy-bibtex
+          ];
+
+          org-special-block-extras = ignoreCompilationError super.org-special-block-extras; # elisp error
+
+          # https://github.com/ichernyshovvv/org-timeblock/issues/65
+          org-timeblock = markBroken super.org-timeblock;
+
+          org-trello = ignoreCompilationError super.org-trello; # elisp error
+
+          # Requires xwidgets compiled into emacs, so mark this package
+          # as broken if emacs hasn't been compiled with the flag.
+          org-xlatex = if self.emacs.withXwidgets then super.org-xlatex else markBroken super.org-xlatex;
+
+          # Optimizer error: too much on the stack
+          orgnav = ignoreCompilationError super.orgnav;
+
           origami-predef = ignoreCompilationError super.origami-predef; # elisp error
 
           # https://github.com/DarwinAwardWinner/mac-pseudo-daemon/issues/9
@@ -1777,9 +1779,6 @@ let
           # optional dependency spamfilter is not on any ELPA
           wanderlust = ignoreCompilationError (addPackageRequires super.wanderlust [ self.shimbun ]);
 
-          # https://github.com/nicklanasa/xcode-mode/issues/28
-          xcode-mode = addPackageRequires super.xcode-mode [ self.hydra ];
-
           weechat = ignoreCompilationError super.weechat; # elisp error
 
           weechat-alert = ignoreCompilationError super.weechat-alert; # elisp error
@@ -1788,17 +1787,20 @@ let
 
           workgroups2 = ignoreCompilationError super.workgroups2; # elisp error
 
+          # https://github.com/nicklanasa/xcode-mode/issues/28
+          xcode-mode = addPackageRequires super.xcode-mode [ self.hydra ];
+
           xenops = mkHome super.xenops;
 
           # missing optional dependencies
           xmlunicode = addPackageRequires super.xmlunicode [ self.helm ];
 
-          # https://github.com/canatella/xwwp/issues/18
-          xwwp-follow-link-ivy = addPackageRequires super.xwwp-follow-link-ivy [ self.ivy ];
-
           # https://github.com/canatella/xwwp/issues/19
           xwwp-follow-link-helm = addPackageRequires super.xwwp-follow-link-helm [ self.helm ];
 
+          # https://github.com/canatella/xwwp/issues/18
+          xwwp-follow-link-ivy = addPackageRequires super.xwwp-follow-link-ivy [ self.ivy ];
+
           yara-mode = ignoreCompilationError super.yara-mode; # elisp error
 
           # https://github.com/leanprover-community/yasnippet-lean/issues/6
@@ -1818,6 +1820,8 @@ let
 
           # missing optional dependencies
           zotxt = addPackageRequires super.zotxt [ self.org-noter ];
+
+          # keep-sorted end
         };
 
     in

pkgs/applications/editors/emacs/elisp-packages/nongnu-common-overrides.nix

@@ -8,6 +8,7 @@ let
     ;
 in
 {
+  # keep-sorted start block=yes newline_separated=yes
   # missing optional dependencies
   haskell-tng-mode = addPackageRequires super.haskell-tng-mode (
     with self;
@@ -35,4 +36,5 @@ in
       popd
     '';
   };
+  # keep-sorted end
 }

pkgs/applications/editors/emacs/elisp-packages/nongnu-devel-packages.nix

@@ -46,11 +46,13 @@ let
       commonOverrides = import ./nongnu-common-overrides.nix pkgs lib;
 
       overrides = self: super: {
+        # keep-sorted start block=yes newline_separated=yes
         # missing optional dependencies
         haskell-tng-mode = addPackageRequires super.haskell-tng-mode [
           self.shut-up
           self.lsp-mode
         ];
+        # keep-sorted end
       };
 
     in

pkgs/applications/editors/emacs/elisp-packages/nongnu-packages.nix

@@ -41,7 +41,10 @@ let
 
       commonOverrides = import ./nongnu-common-overrides.nix pkgs lib;
 
-      overrides = self: super: { };
+      overrides = self: super: {
+        # keep-sorted start block=yes newline_separated=yes
+        # keep-sorted end
+      };
 
     in
     let