Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

[kondo] Squelch missing-docstring linter for Potemkin-imported vars (#82812)

Oleksandr Yakushev81736f712a09
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.edn
index 52cfaee5bef..97155c9c939 100644
--- a/.clj-kondo/config.edn
+++ b/.clj-kondo/config.edn
@@ -854,7 +854,13 @@
metabase.users.models.user-test/with-groups! macros.metabase.users.models.user-test/with-groups!
metabase.util.namespaces/import-fn macros.metabase.util.namespaces/import-fn
metabase.util.namespaces/import-macro macros.metabase.util.namespaces/import-macro
- metabase.xrays.related-test/with-world macros.metabase.xrays.related-test/with-world}}
+ metabase.xrays.related-test/with-world macros.metabase.xrays.related-test/with-world
+ potemkin/import-def macros.potemkin.namespaces/import-def
+ potemkin/import-fn macros.potemkin.namespaces/import-fn
+ potemkin/import-macro macros.potemkin.namespaces/import-macro
+ potemkin.namespaces/import-def macros.potemkin.namespaces/import-def
+ potemkin.namespaces/import-fn macros.potemkin.namespaces/import-fn
+ potemkin.namespaces/import-macro macros.potemkin.namespaces/import-macro}}
:config-in-comment
{:linters {:unresolved-symbol {:level :off}}}
diff --git a/.clj-kondo/macros/potemkin/namespaces.clj b/.clj-kondo/macros/potemkin/namespaces.clj
new file mode 100644
index 00000000000..765e99223b9
--- /dev/null
+++ b/.clj-kondo/macros/potemkin/namespaces.clj
@@ -0,0 +1,21 @@
+(ns macros.potemkin.namespaces)
+
+(defn- import-var-expansion
+ "Expansion shared by all of the `import-*` replacements below. Synthetic \"docstring\" is needed to silence
+ `:missing-docstring` linter."
+ ([sym]
+ (import-var-expansion sym (-> sym name symbol)))
+ ([sym new-name]
+ `(def ~new-name "docstring" ~sym)))
+
+(defmacro import-def
+ ([sym] (import-var-expansion sym))
+ ([sym new-name] (import-var-expansion sym new-name)))
+
+(defmacro import-fn
+ ([sym] (import-var-expansion sym))
+ ([sym new-name] (import-var-expansion sym new-name)))
+
+(defmacro import-macro
+ ([sym] (import-var-expansion sym))
+ ([sym new-name] (import-var-expansion sym new-name)))
diff --git a/src/metabase/cache/core.clj b/src/metabase/cache/core.clj
index 7eaac390a88..213a772b205 100644
--- a/src/metabase/cache/core.clj
+++ b/src/metabase/cache/core.clj
@@ -7,8 +7,6 @@
(comment metabase.cache.models.cache-config/keep-me
metabase.cache.settings/keep-me)
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.cache.models.cache-config/invalidate! invalidate-config!)
(p/import-vars
diff --git a/src/metabase/driver_api/core.clj b/src/metabase/driver_api/core.clj
index 4eb9375b3bf..fda1f121af8 100644
--- a/src/metabase/driver_api/core.clj
+++ b/src/metabase/driver_api/core.clj
@@ -1,6 +1,4 @@
(ns metabase.driver-api.core
- ;; missing docstring warnings are false positives because of Potemkin
- {:clj-kondo/config '{:linters {:missing-docstring {:level :off}}}}
(:refer-clojure :exclude [replace compile])
(:require
[metabase.actions.core :as actions]
diff --git a/src/metabase/permissions/core.clj b/src/metabase/permissions/core.clj
index 90d63dca481..bef8acde2c6 100644
--- a/src/metabase/permissions/core.clj
+++ b/src/metabase/permissions/core.clj
@@ -1,6 +1,5 @@
(ns metabase.permissions.core
"`permissions` module API namespace."
- {:clj-kondo/config '{:linters {:missing-docstring {:level :off}}}}
(:require
[metabase.permissions.data-access-token]
[metabase.permissions.models.application-permissions-revision]
diff --git a/src/metabase/queries/core.clj b/src/metabase/queries/core.clj
index 42d3b940676..aa40dd77f4e 100644
--- a/src/metabase/queries/core.clj
+++ b/src/metabase/queries/core.clj
@@ -78,20 +78,12 @@
[metabase.query-processor.card
parameter-template-tag?])
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.queries.models.card/populate-query-fields populate-card-query-fields)
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.query-processor.card/template-tag-parameters card-template-tag-parameters)
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.queries.models.parameter-card/delete-all-for-parameterized-object!
delete-all-parameter-cards-for-parameterized-object!)
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.queries.models.parameter-card/upsert-or-delete-from-parameters!
upsert-or-delete-parameter-cards-from-parameters!)
diff --git a/src/metabase/sso/core.clj b/src/metabase/sso/core.clj
index 992f885ba24..d183735f37d 100644
--- a/src/metabase/sso/core.clj
+++ b/src/metabase/sso/core.clj
@@ -33,10 +33,6 @@
[metabase.sso.ldap.settings
ldap-enabled])
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.sso.ldap.default-implementation/UserInfo LDAPUserInfo)
-;; the re-exported var carries the docstring; kondo can't see through import-def
-#_{:clj-kondo/ignore [:missing-docstring]}
(p/import-def metabase.sso.ldap.default-implementation/search ldap-search)
diff --git a/src/metabase/warehouse_schema/models/field.clj b/src/metabase/warehouse_schema/models/field.clj
index 81c5cb6f1dd..83b503a7d46 100644
--- a/src/metabase/warehouse_schema/models/field.clj
+++ b/src/metabase/warehouse_schema/models/field.clj
@@ -30,7 +30,6 @@
(comment metabase.lib.schema.metadata/keep-me)
-#_{:clj-kondo/ignore [:missing-docstring]} ; false positive
(p/import-def metabase.lib.schema.metadata/column-visibility-types visibility-types)
(def data-sensitivity-types