Add format rules for dune files (#1821)

* Rename unstable-fmt to format-dune-file

Signed-off-by: Etienne Millon <[email protected]>

* Format rules: in 1.1, format dune files

Signed-off-by: Etienne Millon <[email protected]>

* Remove --inplace option for format-dune-file

This command is to be only used with formatting rules, where fixing
files is done using promotion.

Signed-off-by: Etienne Millon <[email protected]>

* Rename Dune_fmt to Format_dune_lang

Signed-off-by: Etienne Millon <[email protected]>

Author: emillon

CHANGES.md

@@ -134,6 +134,11 @@ unreleased
   necessary until virtual libraries were supported (#1822, fix #1816,
   @diml)
 
+- Rename `unstable-fmt` to `format-dune-file` and remove its `--inplace` option.
+  (#1821, @emillon).
+
+- Autoformatting: `(using fmt 1.1)` will also format dune files (#1821, @emillon).
+
 1.6.2 (05/12/2018)
 ------------------
 

bin/fmt_cmd.ml

@@ -0,0 +1,25 @@
+open Import
+open Stdune
+
+module Format_dune_lang = Dune.Format_dune_lang
+
+let doc = "Format dune files"
+
+let man =
+  [ `S "DESCRIPTION"
+  ; `P {|$(b,dune format-dune-file) reads a dune file and outputs a formatted
+           version. |}
+  ]
+
+let info = Term.info "format-dune-file" ~doc ~man
+
+let term =
+  let%map path_opt =
+    let docv = "FILE" in
+    let doc = "Path to the dune file to parse." in
+    Arg.(value & pos 0 (some path) None & info [] ~docv ~doc)
+  in
+  let input = Option.map ~f:Arg.Path.path path_opt in
+  Format_dune_lang.format_file ~input
+
+let command = term, info

bin/format_dune_file.ml

@@ -141,7 +141,7 @@ let all =
   ; promote
   ; Printenv.command
   ; Help.command
-  ; Fmt_cmd.command
+  ; Format_dune_file.command
   ; Compute.command
   ; Upgrade.command
   ]

bin/fmt_cmd.mli renamed to bin/format_dune_file.mli

@@ -44,6 +44,15 @@
  (package dune)
  (files   dune-external-lib-deps.1))
 
+(rule
+ (with-stdout-to dune-format-dune-file.1
+  (run dune format-dune-file --help=groff)))
+
+(install
+ (section man)
+ (package dune)
+ (files   dune-format-dune-file.1))
+
 (rule
  (with-stdout-to dune-help.1
   (run dune help --help=groff)))
@@ -125,15 +134,6 @@
  (package dune)
  (files   dune-uninstall.1))
 
-(rule
- (with-stdout-to dune-unstable-fmt.1
-  (run dune unstable-fmt --help=groff)))
-
-(install
- (section man)
- (package dune)
- (files   dune-unstable-fmt.1))
-
 (rule
  (with-stdout-to dune-upgrade.1
   (run dune upgrade --help=groff)))

bin/main.ml

@@ -19,7 +19,7 @@ This feature is enabled by adding the following to the ``dune-project`` file:
 
 .. code:: scheme
 
-    (using fmt 1.0)
+    (using fmt 1.1)
 
 Formatting a project
 ====================
@@ -63,4 +63,17 @@ the languages that are considered for formatting.
 
 .. code:: scheme
 
-    (using fmt 1.0 (enabled_for reason))
+    (using fmt 1.1 (enabled_for reason))
+
+Version history
+===============
+
+1.1
+---
+
+* Format Dune files.
+
+1.0
+---
+
+* Format OCaml (using ocamlformat_) and Reason (using refmt_) source code.

doc/dune.inc

@@ -538,35 +538,42 @@ module Auto_format = struct
   let syntax =
     Syntax.create ~name:"fmt"
       ~desc:"integration with automatic formatters"
-      [ (1, 0) ]
+      [ (1, 1) ]
 
   type language =
     | Ocaml
     | Reason
+    | Dune
 
   let language_to_sexp = function
     | Ocaml -> Sexp.Atom "ocaml"
     | Reason -> Sexp.Atom "reason"
+    | Dune -> Sexp.Atom "dune"
 
   let language =
     sum
       [ ("ocaml", return Ocaml)
       ; ("reason", return Reason)
+      ; ("dune",
+         let%map () = Syntax.since syntax (1, 1) in
+         Dune)
       ]
 
   type enabled_for =
-    | Default
+    | Default of Syntax.Version.t
     | Only of language list
 
   let enabled_for_field =
-    let%map r = field_o "enabled_for" (repeat language) in
+    let%map r = field_o "enabled_for" (repeat language)
+    and version = Syntax.get_exn syntax
+    in
     match r with
     | Some l -> Only l
-    | None -> Default
+    | None -> Default version
 
   let enabled_for_to_sexp =
     function
-    | Default -> Sexp.Atom "default"
+    | Default v -> Sexp.List [Atom "default"; Syntax.Version.to_sexp v]
     | Only l -> List [Atom "only"; List (List.map ~f:language_to_sexp l)]
 
   type t =
@@ -587,6 +594,25 @@ module Auto_format = struct
 
   let key =
     Dune_project.Extension.register syntax dparse_args to_sexp
+
+  let enabled_languages config =
+    match config.enabled_for with
+    | Default ver ->
+      let in_1_0 =
+        [Ocaml; Reason]
+      in
+      let extra =
+        match Syntax.Version.compare ver (1, 1) with
+        | Lt -> []
+        | Eq | Gt -> [Dune]
+      in
+      in_1_0 @ extra
+    | Only l -> l
+
+  let includes config language =
+    List.mem language ~set:(enabled_languages config)
+
+  let loc t = t.loc
 end
 
 module Buildable = struct

doc/formatting.rst

@@ -97,19 +97,15 @@ module Auto_format : sig
   type language =
     | Ocaml
     | Reason
+    | Dune
 
-  type enabled_for =
-    | Default
-    | Only of language list
+  type t
 
-  type t =
-    { loc : Loc.t
-    ; enabled_for : enabled_for
-    }
+  val key : t Dune_project.Extension.t
 
-  val syntax : Syntax.t
+  val loc : t -> Loc.t
 
-  val key : t Dune_project.Extension.t
+  val includes : t -> language -> bool
 end
 
 module Buildable : sig