Merge pull request #103 from mbarbin/auto-load-root-dunolint

mbarbin · web-flow · commit ae43f28b9b7a · 2025-09-10T12:34:31.000+02:00
Auto load root dunolint
diff --git a/CHANGES.md b/CHANGES.md
@@ -6,6 +6,7 @@
 
 ### Changed
 
+- Now autoload config files if present at "$PWD/dunolint" (#102, @mbarbin).
 - Change dune-lang sexps to be atoms (e.g. "3.19") instead of tuples (#101, @mbarbin).
 - Remove base and ppx dependencies from `dunolint-lib` (#99, @mbarbin).
 - Always use versioned sexp for config (#98, @mbarbin).
diff --git a/lib/dunolint_cli/src/cmd__lint.ml b/lib/dunolint_cli/src/cmd__lint.ml
@@ -37,19 +37,7 @@ let main =
        >>| List.map ~f:(fun condition -> `enforce condition)
      in
      let config =
-       match config with
-       | Some filename -> Common_helpers.load_config_exn ~filename
-       | None ->
-         Dunolint.Config.create
-           ~skip_subtree:(Common_helpers.skip_subtree ~globs:[])
-           ~rules:[]
-           ()
-     in
-     let config =
-       Dunolint.Config.create
-         ?skip_subtree:(Dunolint.Config.skip_subtree config)
-         ~rules:(Dunolint.Config.rules config @ enforce)
-         ()
+       Common_helpers.load_config_opt_exn ~config ~append_extra_rules:enforce
      in
      Dunolint_engine.run ~config:dunolint_engine_config
      @@ fun dunolint_engine ->
diff --git a/lib/dunolint_cli/src/cmd__tools__lint_file.ml b/lib/dunolint_cli/src/cmd__tools__lint_file.ml
@@ -197,19 +197,7 @@ let main =
      let save_in_place = save_in_place ~in_place ~file in
      let cwd = Unix.getcwd () |> Absolute_path.v in
      let config =
-       match config with
-       | Some filename -> Common_helpers.load_config_exn ~filename
-       | None ->
-         Dunolint.Config.create
-           ~skip_subtree:(Common_helpers.skip_subtree ~globs:[])
-           ~rules:[]
-           ()
-     in
-     let config =
-       Dunolint.Config.create
-         ?skip_subtree:(Dunolint.Config.skip_subtree config)
-         ~rules:(Dunolint.Config.rules config @ enforce)
-         ()
+       Common_helpers.load_config_opt_exn ~config ~append_extra_rules:enforce
      in
      let path = select_path ~cwd ~filename ~file in
      let linter = select_linter ~path:(path :> Fpath.t) in
diff --git a/lib/dunolint_cli/src/common_helpers.ml b/lib/dunolint_cli/src/common_helpers.ml
@@ -108,3 +108,21 @@ let load_config_exn ~filename =
        in
        Err.raise ~loc [ message ])
 ;;
+
+let load_config_opt_exn ~config ~append_extra_rules =
+  let config =
+    match config with
+    | Some filename -> load_config_exn ~filename
+    | None ->
+      let cwd = Unix.getcwd () |> Absolute_path.v in
+      let default_file = Absolute_path.extend cwd (Fsegment.v "dunolint") in
+      let filename = Absolute_path.to_string default_file in
+      if Stdlib.Sys.file_exists filename
+      then load_config_exn ~filename
+      else Dunolint.Config.create ~skip_subtree:(skip_subtree ~globs:[]) ~rules:[] ()
+  in
+  Dunolint.Config.create
+    ?skip_subtree:(Dunolint.Config.skip_subtree config)
+    ~rules:(Dunolint.Config.rules config @ append_extra_rules)
+    ()
+;;
diff --git a/lib/dunolint_cli/src/common_helpers.mli b/lib/dunolint_cli/src/common_helpers.mli
@@ -31,3 +31,10 @@ val skip_subtree : globs:string list -> Dunolint.Config.Skip_subtree.t
 (** A helper for loading the config with some effort regarding producing located
     error messages when able. *)
 val load_config_exn : filename:string -> Dunolint.Config.t
+
+(** A helper to load a config file, either supplied or inferred from the context
+    and add some optional rules. *)
+val load_config_opt_exn
+  :  config:string option
+  -> append_extra_rules:Dunolint.Config.Rule.t list
+  -> Dunolint.Config.t
diff --git a/test/cram/interactive.t b/test/cram/interactive.t
@@ -25,7 +25,7 @@ Where this is nothing to lint, the interactive command exits with no prompt.
 Let's create a config with some rules that are going to apply to the files we
 created.
 
-  $ cat > .dunolint <<EOF
+  $ cat > dunolint <<EOF
   > ((rules (
   >   (enforce (dune (library (name (equals foo)))))
   >   (enforce (dune_project (name (equals foo))))
@@ -34,7 +34,7 @@ created.
 
 We run the lint command in dry-run mode to visualize the changes suggested.
 
-  $ dunolint lint --config=.dunolint --dry-run
+  $ dunolint lint --config=dunolint --dry-run
   dry-run: Would edit file "dune-project":
   -1,1 +1,1
   -|(name main)
@@ -48,7 +48,7 @@ We run the lint command in dry-run mode to visualize the changes suggested.
 
 Note it is possible to restrict the run to a subdirectory only.
 
-  $ dunolint lint --config=.dunolint --dry-run --below lib/
+  $ dunolint lint --config=dunolint --dry-run --below lib/
   dry-run: Would edit file "lib/foo/dune":
   -1,2 +1,2
     (library
@@ -63,7 +63,7 @@ We disable the pager for the test.
 
 We can quit at any time during the interactive loop.
 
-  $ printf 'q\n' | dunolint lint --config=.dunolint --interactive
+  $ printf 'q\n' | dunolint lint --config=dunolint --interactive
   Would edit file "dune-project":
   -1,1 +1,1
   -|(name main)
@@ -73,7 +73,7 @@ We can quit at any time during the interactive loop.
 
 We can choose to refuse some diff, and accept others.
 
-  $ printf 'n\ny\n' | dunolint lint --config=.dunolint --interactive
+  $ printf 'n\ny\n' | dunolint lint --config=dunolint --interactive
   Would edit file "dune-project":
   -1,1 +1,1
   -|(name main)
diff --git a/test/cram/lint-file.t b/test/cram/lint-file.t
@@ -109,19 +109,19 @@ Next we are going to test the command with config.
 
 The command may be passed a config file.
 
-  $ printf '((rules ()))\n' > .dunolint
+  $ printf '((rules ()))\n' > dunolint
 
-  $ dunolint tools lint dune --config=.dunolint
+  $ dunolint tools lint dune --config=dunolint
   (library
    (name mylib)
    (libraries a b c))
 
 To make it easier to write in this test, we're generating an actual config from
 an OCaml file.
 
-  $ ./lint_file_config_gen.exe > .dunolint
+  $ ./lint_file_config_gen.exe > dunolint
 
-  $ cat .dunolint
+  $ cat dunolint
   ;; This file is generated by [bin/lint_file_gen_config.ml]. Do not edit!
   ((version 0)
    ((skip_subtree (cond (((path (glob .git/*)) skip_subtree))))
@@ -137,18 +137,27 @@ an OCaml file.
   > (name my_project_name)
   > EOF
 
-Currently the behavior of the lint-file command is to not load config files on
-its own. See below how the name of the project is not linted:
+Currently the behavior of the lint-file command is to load a config file on its
+own if it is in the current cwd and named "dunolint". See below how the name of
+the project is indeed linted:
 
   $ dunolint tools lint-file dune-project
   (lang dune 3.17)
   
+  (name foo)
+
+However, you may supply a config to use.
+
+  $ printf "((rules()))\n" > empty-config
+  $ dunolint tools lint-file dune-project --config=empty-config
+  (lang dune 3.17)
+  
   (name my_project_name)
 
-However, you may supply a config to use. The test config enforces the project
-name so its effect is visible in this test (it is changed to "foo"):
+The test config enforces the project name so its effect is visible in this test
+(it is changed to "foo"):
 
-  $ dunolint tools lint-file dune-project --config=.dunolint
+  $ dunolint tools lint-file dune-project --config=dunolint
   (lang dune 3.17)
   
   (name foo)
@@ -170,7 +179,7 @@ The path that is used by the config is the filename supplied when it is
 overridden. In particular note how here we are executing the `return` statement
 of the config.
 
-  $ dunolint tools lint-file dune-project --config=.dunolint \
+  $ dunolint tools lint-file dune-project --config=dunolint \
   >   --filename=vendor/dune-project
   (lang dune 3.17)
   
@@ -179,20 +188,20 @@ of the config.
 If the file is at a path configured to be in a skipped directory, the command
 won't apply linting rules to it.
 
-  $ cat dune | dunolint tools lint-file --filename=.git/dune
+  $ cat dune | dunolint tools lint-file --filename=.git/dune --config=empty-config
   (library
    (name mylib)
    (libraries a b c))
 
-  $ cat dune | dunolint tools lint-file --filename=.git/dune --config=.dunolint
+  $ cat dune | dunolint tools lint-file --filename=.git/dune --config=dunolint
   (library (name mylib)
    (libraries b c a))
 
 Note however that the result is currently different when the `skip_subtree` is
 returned from a rule, rather than from the dedicated section. This is probably
 confusing and we may revisit this later. Keeping as a regression test for now.
 
-  $ cat dune | dunolint tools lint-file --filename=_build/dune --config=.dunolint
+  $ cat dune | dunolint tools lint-file --filename=_build/dune --config=dunolint
   (library
    (name mylib)
    (libraries b c a))
diff --git a/test/cram/lint.t b/test/cram/lint.t
@@ -37,10 +37,10 @@ its own. See below how the name of the project is not linted:
 
 If the config is supplied, but it is invalid, dunolint will complain.
 
-  $ printf '(blah)\n' > .dunolint
+  $ printf '(blah)\n' > dunolint
 
-  $ dunolint lint --yes --config .dunolint
-  File ".dunolint", line 1, characters 1-5:
+  $ dunolint lint --yes --config=dunolint
+  File "dunolint", line 1, characters 1-5:
   1 | (blah)
        ^^^^
   Error: config.v0.t_of_sexp: record conversion: only pairs expected, their
@@ -49,27 +49,27 @@ If the config is supplied, but it is invalid, dunolint will complain.
 
 Unsupported config versions are reported with a located error message.
 
-  $ printf '((version 101101)(blah))\n' > .dunolint
+  $ printf '((version 101101)(blah))\n' > dunolint
 
-  $ dunolint lint --yes --config .dunolint
-  File ".dunolint", line 1, characters 10-16:
+  $ dunolint lint --yes --config=dunolint
+  File "dunolint", line 1, characters 10-16:
   1 | ((version 101101)(blah))
                 ^^^^^^
   Error: Unsupported dunolint config version [101101].
   [123]
 
 If there are no rules, the linting will succeed but does nothing in this case.
 
-  $ printf '((rules ()))\n' > .dunolint
+  $ printf '((rules ()))\n' > dunolint
 
-  $ dunolint lint --yes --config .dunolint
+  $ dunolint lint --yes --config=dunolint
 
 Now let's load a config. To make it easier to write in this test, we're
 generating an actual config from an OCaml file.
 
-  $ ./lint_file_config_gen.exe > .dunolint
+  $ ./lint_file_config_gen.exe > dunolint
 
-  $ cat .dunolint
+  $ cat dunolint
   ;; This file is generated by [bin/lint_file_gen_config.ml]. Do not edit!
   ((version 0)
    ((skip_subtree (cond (((path (glob .git/*)) skip_subtree))))
@@ -81,7 +81,7 @@ generating an actual config from an OCaml file.
 
 Let's lint with this config.
 
-  $ dunolint lint --yes --config .dunolint
+  $ dunolint lint --yes --config=dunolint
   Editing file "dune-project":
   -1,3 +1,3
     (lang dune 3.17)
