feat(customisation): Make Projectile configuration optional

Add a new `prelude-projectile` user option, so that integration with
Projectile can optionally be disabled.

This is enabled by default, but it can be useful to turn this off --
for example, if one wishes instead to use Emacs' native `project.el` for
project interaction.

Refs: https://github.com/bbatsov/projectile

Author: spdawson

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Add `prelude-vertico` module. Vertico a simpler alternative to `ivy-mode` and supersedes Selectrum.
 - [#1421](https://github.com/bbatsov/prelude/issues/1421): Make it possible to configure the TypeScript format action using `prelude-ts-format-action`.
 - [#1354](https://github.com/bbatsov/prelude/issues/1354): Remove default `C--` and `C-+` keybindings to increase/decrease the font size.
+- Add `prelude-projectile` user option, allowing Projectile integration to be disabled.
 
 ### Changes
 

core/prelude-custom.el

@@ -122,6 +122,11 @@ Only modes that don't derive from `prog-mode' should be listed here."
   :type 'symbol
   :group 'prelude)
 
+(defcustom prelude-projectile t
+  "Non-nil values enable Prelude's Projectile integration."
+  :type 'boolean
+  :group 'prelude)
+
 (provide 'prelude-custom)
 
 ;;; prelude-custom.el ends here

core/prelude-editor.el

@@ -221,9 +221,10 @@
       bookmark-save-flag 1)
 
 ;; projectile is a project management mode
-(require 'projectile)
-(setq projectile-cache-file (expand-file-name  "projectile.cache" prelude-savefile-dir))
-(projectile-mode t)
+(when prelude-projectile
+  (require 'projectile)
+  (setq projectile-cache-file (expand-file-name  "projectile.cache" prelude-savefile-dir))
+  (projectile-mode t))
 
 ;; avy allows us to effectively navigate to visible things
 (require 'avy)

core/prelude-mode.el

@@ -65,10 +65,11 @@
     (define-key map (kbd "C-c I") 'crux-find-user-init-file)
     (define-key map (kbd "C-c S") 'crux-find-shell-init-file)
     (define-key map (kbd "C-c i") 'imenu-anywhere)
-    ;; extra prefix for projectile
-    (when prelude-super-keybindings
-     (define-key map (kbd "s-p") 'projectile-command-map))
-    (define-key map (kbd "C-c p") 'projectile-command-map)
+    (when prelude-projectile
+      ;; extra prefix for projectile
+      (when prelude-super-keybindings
+        (define-key map (kbd "s-p") 'projectile-command-map))
+      (define-key map (kbd "C-c p") 'projectile-command-map))
     ;; make some use of the Super key
     (when prelude-super-keybindings
       ;; crux

docs/configuration.md

@@ -176,6 +176,15 @@ desktop environments might be making heavy use of such keybindings. (in most cas
 (setq prelude-super-keybindings nil)
 ```
 
+### Disable Projectile
+
+By default, Prelude configures [Projectile](https://github.com/bbatsov/projectile) for project
+interaction. To disable this, add the following to your config.
+
+``` emacs-lisp
+(setq prelude-projectile nil)
+```
+
 ### Configuration per file or directory
 
 Some of these settings (those that don't need to be pre-loaded) can also be set

modules/prelude-erlang.el

@@ -38,7 +38,8 @@
   :type 'string
   :safe 'stringp)
 
-(require 'projectile)
+(when prelude-projectile
+  (require 'projectile))
 
 (when (require 'erlang-start nil t)
 
@@ -49,8 +50,9 @@
     (add-to-list 'load-path wrangler-path)
     (require 'wrangler)))
 
-(add-hook 'erlang-mode-hook (lambda ()
-                              (setq erlang-compile-function 'projectile-compile-project)))
+(when prelude-projectile
+  (add-hook 'erlang-mode-hook (lambda ()
+                                (setq erlang-compile-function 'projectile-compile-project))))
 
 (provide 'prelude-erlang)
 

modules/prelude-go.el

@@ -38,7 +38,8 @@
                             company
                             gotest))
 
-(require 'go-projectile)
+(when prelude-projectile
+  (require 'go-projectile))
 
 ;; Ignore go test -c output files
 (add-to-list 'completion-ignored-extensions ".test")

modules/prelude-helm-everywhere.el

@@ -63,8 +63,9 @@
 (helm-descbinds-mode)
 (helm-mode 1)
 
-;; enable Helm version of Projectile with replacment commands
-(helm-projectile-on)
+(when when prelude-projectile
+      ;; enable Helm version of Projectile with replacment commands
+      (helm-projectile-on))
 
 (provide 'prelude-helm-everywhere)
 ;; prelude-helm-everywhere.el ends here.

modules/prelude-helm.el

@@ -33,7 +33,8 @@
 
 (prelude-require-packages '(helm helm-projectile))
 
-(require 'helm-projectile)
+(when prelude-projectile
+  (require 'helm-projectile))
 
 (when (executable-find "curl")
   (setq helm-google-suggest-use-curl-p t))