Merge pull request #104 from mbarbin/more-dunolint-invariants

mbarbin · web-flow · commit f9c0ccd79285 · 2025-10-06T12:09:25.000+02:00
Add project specific dunolint invariants
diff --git a/bin/dune b/bin/dune
@@ -5,4 +5,6 @@
  (flags :standard -w +a-4-40-41-42-44-45-48-66 -warn-error +a)
  (libraries cmdlang-cmdliner-err-runner volgo-vcs.volgo-vcs-cli)
  (instrumentation
-  (backend bisect_ppx)))
+  (backend bisect_ppx))
+ (lint
+  (pps ppx_js_style -allow-let-operators -check-doc-comments)))
diff --git a/dunolint b/dunolint
@@ -1,31 +1,71 @@
 (lang dunolint 1.0)
 
-;; Build & vcs
-(skip_paths
-  _build/**
-  _coverage/**
-  _opam/**
-  .git/**)
-
-;; Docusaurus build & Co.
-(skip_paths
-  doc/.docusaurus/**
-  doc/build/**
-  doc/node_modules/**)
-
 ;; Everything is instrumented
 (rule
- (enforce (dune (instrumentation (backend bisect_ppx)))))
+ (enforce
+  (dune
+   (instrumentation
+    (backend bisect_ppx)))))
+
+;; Test lib naming
+(rule
+ (cond
+  ((path
+    (glob **/test/*))
+   (enforce
+    (dune
+     (library
+      (and
+       (public_name
+        (is_prefix volgo-tests.))
+       (name
+        (is_suffix _test)))))))))
 
-;; We use linters via pps
+;; Configure the ppx_js_style linter
 (rule
  (enforce
   (dune
-   (library
-    (lint
-     (pps
-      (and
-       (pp ppx_js_style)
-       (flag (name -allow-let-operators) (param none) (applies_to (pp ppx_js_style)))
-       (flag (name -check-doc-comments)  (param none) (applies_to (pp ppx_js_style)))
-       )))))))
+   (lint
+    (pps
+     (and
+      (pp ppx_js_style)
+      (flag
+       (name -allow-let-operators)
+       (param none)
+       (applies_to
+        (pp ppx_js_style)))
+      (flag
+       (name -check-doc-comments)
+       (param none)
+       (applies_to
+        (pp ppx_js_style)))))))))
+
+;; Configure ppx flags
+(rule
+ (cond
+  ((dune
+    (preprocess (pps true)))
+   (enforce
+    (dune
+     (preprocess
+      (pps
+       (flag
+        (name -unused-code-warnings)
+        (param
+         (equals force))
+        (applies_to driver)))))))))
+
+;; With the exceptions of two libraries we made a deliberate effort not to
+;; depend on ppx except in dev mode for the user facing libraries in this
+;; project. Let's enforce this going forward.
+(rule
+ (cond
+  ((path
+    (or
+     (glob **/volgo_base/**)
+     (glob **/vcs_test_helpers/**)))
+   return)
+  ((path (glob **/src/*))
+   (enforce
+    (dune
+     (preprocess no_preprocessing))))))
