Add a targets-impl command for implementations

Author: panglesd

src/odoc/bin/main.ml

@@ -774,6 +774,8 @@ module Make_renderer (R : S) : sig
 
   val targets : docs:string -> unit Term.t * Term.info
 
+  val targets_impl : docs:string -> unit Term.t * Term.info
+
   val generate : docs:string -> unit Term.t * Term.info
 
   val generate_impl : docs:string -> unit Term.t * Term.info
@@ -936,6 +938,34 @@ end = struct
   end
 
   let targets ~docs = Targets.(cmd, info ~docs)
+
+  module Targets_impl = struct
+    let list_targets output_dir source_file extra odoc_file =
+      let odoc_file = Fs.File.of_string odoc_file in
+      let warnings_options =
+        { Odoc_model.Error.warn_error = false; print_warnings = false }
+      in
+      Rendering.targets_impl_odoc ~warnings_options ~syntax:OCaml
+        ~renderer:R.renderer ~output:output_dir ~extra ~source_file odoc_file
+
+    let source_file = Generate_impl.source_file
+
+    let cmd =
+      Term.(
+        const handle_error
+        $ (const list_targets $ dst () $ source_file $ R.extra_args
+         $ input_odocl))
+
+    let info ~docs =
+      let doc =
+        Format.sprintf
+          "Print the files that would be generated by $(i,%s-generate)."
+          R.renderer.name
+      in
+      Term.info (R.renderer.name ^ "-targets-impl") ~docs ~doc
+  end
+
+  let targets_impl ~docs = Targets_impl.(cmd, info ~docs)
 end
 
 module Odoc_latex_url : sig
@@ -1508,6 +1538,7 @@ let () =
       Targets.Support_files.(cmd, info ~docs:section_support);
       Odoc_error.(cmd, info ~docs:section_support);
       Odoc_html.targets ~docs:section_support;
+      Odoc_html.targets_impl ~docs:section_support;
       Odoc_manpage.targets ~docs:section_support;
       Odoc_latex.targets ~docs:section_support;
       Depends.Compile.(cmd, info ~docs:section_support);

src/odoc/rendering.ml

@@ -150,3 +150,38 @@ let targets_odoc ~resolver ~warnings_options ~syntax ~renderer ~output:root_dir
           Format.printf "%a\n" Fpath.pp filename))
     docs;
   Ok ()
+
+let targets_impl_odoc ~syntax ~warnings_options ~renderer ~output:root_dir
+    ~extra ~source_file odoctree =
+  Odoc_file.load odoctree >>= fun unit ->
+  match unit.content with
+  | Odoc_file.Impl_content impl ->
+      documents_of_implementation ~warnings_options ~syntax impl source_file
+      >>= fun docs ->
+      List.iter
+        (fun doc ->
+          let pages = renderer.Renderer.render extra None doc in
+          Renderer.traverse pages ~f:(fun filename _content ->
+              let filename =
+                Fpath.normalize @@ Fs.File.append root_dir filename
+              in
+              Format.printf "%a\n" Fpath.pp filename))
+        docs;
+      Ok ()
+  | Page_content _ | Unit_content _ | Asset_content _ ->
+      Error (`Msg "Expected an implementation unit")
+(* let docs = *)
+(*   if Fpath.get_ext odoctree = ".odoc" then *)
+(*     documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax *)
+(*       odoctree *)
+(*   else documents_of_odocl ~warnings_options ~renderer ~extra ~syntax odoctree *)
+(* in *)
+(* docs >>= fun docs -> *)
+(* List.iter *)
+(*   (fun doc -> *)
+(*     let pages = renderer.Renderer.render extra None doc in *)
+(*     Renderer.traverse pages ~f:(fun filename _content -> *)
+(*         let filename = Fpath.normalize @@ Fs.File.append root_dir filename in *)
+(*         Format.printf "%a\n" Fpath.pp filename)) *)
+(*   docs; *)
+(* Ok () *)

src/odoc/rendering.mli

@@ -42,3 +42,13 @@ val targets_odoc :
   extra:'a ->
   Fpath.t ->
   (unit, [> msg ]) result
+
+val targets_impl_odoc :
+  syntax:Renderer.syntax ->
+  warnings_options:Odoc_model.Error.warnings_options ->
+  renderer:'a Renderer.t ->
+  output:Fs.directory ->
+  extra:'a ->
+  source_file:Fpath.t option ->
+  Fs.file ->
+  (unit, [> Or_error.msg ]) result

test/integration/json_expansion_with_sources.t/run.t

@@ -23,26 +23,14 @@ Test the JSON output in the presence of expanded modules.
   html/Main/index.html.json
   html/Main/A/index.html.json
   html/Main/A/B/index.html.json
-  $ odoc html-targets --source a.ml -o html impl-main__A.odocl
-  odoc: unknown option '--source'.
-  Usage: odoc html-targets [OPTION]… FILE.odocl
-  Try 'odoc html-targets --help' or 'odoc --help' for more information.
-  [2]
-  $ odoc html-targets --source main.ml -o html impl-main.odocl
-  odoc: unknown option '--source'.
-  Usage: odoc html-targets [OPTION]… FILE.odocl
-  Try 'odoc html-targets --help' or 'odoc --help' for more information.
-  [2]
-  $ odoc html-targets --source a.ml --as-json -o html impl-main__A.odocl
-  odoc: unknown option '--source'.
-  Usage: odoc html-targets [OPTION]… FILE.odocl
-  Try 'odoc html-targets --help' or 'odoc --help' for more information.
-  [2]
-  $ odoc html-targets --source main.ml --as-json -o html impl-main.odocl
-  odoc: unknown option '--source'.
-  Usage: odoc html-targets [OPTION]… FILE.odocl
-  Try 'odoc html-targets --help' or 'odoc --help' for more information.
-  [2]
+  $ odoc html-targets-impl --source a.ml -o html impl-main__A.odocl
+  html/src/a.ml.html
+  $ odoc html-targets-impl --source main.ml -o html impl-main.odocl
+  html/src/main.ml.html
+  $ odoc html-targets-impl --source a.ml --as-json -o html impl-main__A.odocl
+  html/src/a.ml.html.json
+  $ odoc html-targets-impl --source main.ml --as-json -o html impl-main.odocl
+  html/src/main.ml.html.json
 
   $ odoc html-generate-impl --source a.ml --as-json -o html impl-main__A.odocl
   $ odoc html-generate --as-json -o html main__A.odocl