j emacs: cleanup and add documentation of used emacs pkgs

jeschli/2configs/emacs.nix

@@ -9,72 +9,69 @@ let
     ];
   };
 
-  #emacsWithCustomPackages
+  # The emacs packages that I use
-  emacsPkgs= epkgs: [
+  # I differ between
-    # testing lsp mode
+  # - stable (Packages that I use for some time - happy with it)
-    epkgs.melpaPackages.lsp-ui
+  # - unstable (Packages that I use for some time - but may drop)
-    epkgs.melpaPackages.company-lsp
+  # - testing (Packages that I try out - the new stuff)
-    epkgs.melpaPackages.lsp-treemacs
+  emacsPkgs = epkgs:
-    epkgs.melpaPackages.helm-lsp
+    (with epkgs.melpaPackages ;
-    epkgs.melpaPackages.dap-mode
-    epkgs.melpaPackages.lsp-mode
 
+    ## helm (stable)
+    # emacs completion engine
+    [ helm helm-ag ] ++
+
+    ## deft (testing)
+    # text search for a directory
+    [ deft ] ++
+
+    ## lsp mode (unstable)
+    # Language Server Protocol mode
+    # Used for rust
+    [ company-lsp dap-mode helm-lsp lsp-mode lsp-treemacs lsp-ui ] ++
+
+    ## emacs convenience (stable)
+    # Mixed and general purpose
+    [ ag company direnv evil google-this spacemacs-theme ] ++
+
+    ## common lisp (testing)
+    [ slime ] ++
+
+    ## magit (stable)
+    [ magit ] ++
+
+    ## bunch of programming languages (unstable)
+    [ go-mode haskell-mode nix-mode ] ++
+
+    ## rust (unstable)
+    [ racer rust-mode ] ++
+
+    ## python (stable)
+    # Python IDE for emacs
+    [ elpy ]) ++
+
+    ## org-mode
+    # Org-Mode has several extensions
+    # and can be seen as an application of its own.
+    (with epkgs.melpaPackages ;
     # testing
-    epkgs.melpaPackages.web-mode
+      [ org-super-agenda org-bullets org-ql ] ++
-    epkgs.melpaPackages.js2-mode
+    # unstable
-    epkgs.melpaPackages.xref-js2
+      [ smex org-mime orgit ]
+    ) ++
 
-    epkgs.melpaPackages.academic-phrases
+    # stable
+    (with epkgs.orgPackages ;
+      [ org-plus-contrib ]) ++
 
-    epkgs.melpaPackages.gitlab
+    (with epkgs.elpaPackages ;
-    epkgs.melpaPackages.weechat
+      [ bbdb which-key ]);
 
-# helm
+#    ## EXWM related (unstable)
-    epkgs.melpaPackages.helm
+#    epkgs.exwm
-    epkgs.melpaPackages.helm-fuzzier
+#    epkgs.melpaPackages.desktop-environment
-    epkgs.melpaPackages.helm-ag
+#    epkgs.melpaPackages.helm-exwm
-
+#  ];
-
-# emacs convenience
-    epkgs.melpaPackages.ag
-    epkgs.melpaPackages.company
-    epkgs.melpaPackages.direnv
-    epkgs.melpaPackages.evil
-    epkgs.melpaPackages.google-this
-    epkgs.melpaPackages.monokai-alt-theme
-    epkgs.melpaPackages.spacemacs-theme
-    epkgs.melpaPackages.zenburn-theme
-
-# development
-    epkgs.melpaPackages.magit
-    epkgs.melpaPackages.nix-mode
-    epkgs.melpaPackages.go-mode
-    epkgs.melpaPackages.haskell-mode
-# rust
-    epkgs.melpaPackages.rust-mode
-#    epkgs.melpaPackages.flycheck-rust
-    epkgs.melpaPackages.racer
-
-# python
-    epkgs.melpaPackages.elpy
-
-    # org-mode
-    epkgs.melpaPackages.org-super-agenda
-    epkgs.melpaPackages.org-bullets
-    epkgs.melpaPackages.org-ql
-
-    epkgs.elpaPackages.bbdb
-    epkgs.orgPackages.org-plus-contrib
-    epkgs.melpaPackages.smex
-    epkgs.melpaPackages.org-mime
-    epkgs.melpaPackages.orgit
-
-    epkgs.elpaPackages.which-key
-
-    epkgs.exwm
-    epkgs.melpaPackages.desktop-environment
-    epkgs.melpaPackages.helm-exwm
-  ];
 
   emacsWithOverlay = pkgsWithOverlay.emacsWithPackagesFromUsePackage {
     config = builtins.readFile ./elisp/init.el;