From aa49edc216b30ab7104037a9365aaad06ae09b31 Mon Sep 17 00:00:00 2001
From: Henrik Lissner <git@henrik.io>
Date: Tue, 12 Sep 2023 23:38:01 +0200
Subject: [PATCH] docs(helm,ivy,vertico,ido): add incompatibility checks

These modules tend to conflict if more than one of them are enabled at
once. More systematic compatibility tests are in the works, but for now
this will do.
---
 modules/completion/helm/doctor.el    | 7 +++++++
 modules/completion/ido/doctor.el     | 7 +++++++
 modules/completion/ivy/doctor.el     | 4 ++++
 modules/completion/vertico/doctor.el | 8 +++++++-
 4 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 modules/completion/helm/doctor.el
 create mode 100644 modules/completion/ido/doctor.el

diff --git a/modules/completion/helm/doctor.el b/modules/completion/helm/doctor.el
new file mode 100644
index 000000000..ea80e0b8e
--- /dev/null
+++ b/modules/completion/helm/doctor.el
@@ -0,0 +1,7 @@
+;; -*- lexical-binding: t; no-byte-compile: t; -*-
+;;; completion/helm/doctor.el
+
+(dolist (module '(ivy ido vertico))
+  (when (doom-module-p :completion module)
+    (error! "This module is incompatible with :completion %s; disable one or the other"
+            module)))
diff --git a/modules/completion/ido/doctor.el b/modules/completion/ido/doctor.el
new file mode 100644
index 000000000..9aeb09eb7
--- /dev/null
+++ b/modules/completion/ido/doctor.el
@@ -0,0 +1,7 @@
+;; -*- lexical-binding: t; no-byte-compile: t; -*-
+;;; completion/ido/doctor.el
+
+(dolist (module '(helm ivy vertico))
+  (when (doom-module-p :completion module)
+    (error! "This module is incompatible with :completion %s; disable one or the other"
+            module)))
diff --git a/modules/completion/ivy/doctor.el b/modules/completion/ivy/doctor.el
index a79d37c56..771fdeb93 100644
--- a/modules/completion/ivy/doctor.el
+++ b/modules/completion/ivy/doctor.el
@@ -1,3 +1,7 @@
 ;; -*- lexical-binding: t; no-byte-compile: t; -*-
 ;;; completion/ivy/doctor.el
 
+(dolist (module '(helm ido vertico))
+  (when (doom-module-p :completion module)
+    (error! "This module is incompatible with :completion %s; disable one or the other"
+            module)))
diff --git a/modules/completion/vertico/doctor.el b/modules/completion/vertico/doctor.el
index febc9702d..009c0cbc2 100644
--- a/modules/completion/vertico/doctor.el
+++ b/modules/completion/vertico/doctor.el
@@ -1,4 +1,10 @@
-;;; completion/vertico/doctor.el -*- lexical-binding: t; -*-
+;; -*- lexical-binding: t; no-byte-compile: t; -*-
+;;; completion/vertico/doctor.el
+
+(dolist (module '(ivy helm ido))
+  (when (doom-module-p :completion module)
+    (error! "This module is incompatible with :completion %s; disable one or the other"
+            module)))
 
 (when (require 'consult nil t)
   ;; FIXME: This throws an error if grep is missing.