Remove '--numeric' option and recovery feature (#2333)

Author: gpetiot

CHANGES.md

@@ -2,6 +2,8 @@
 
 ### Removed
 
+- Remove `--numeric` feature (#2333, @gpetiot)
+
 ### Deprecated
 
 ### Bug fixes

bench/bench.ml

@@ -21,7 +21,7 @@ type input =
   ; kind: Syntax.t
   ; source: string
   ; conf: Conf.t
-  ; action: [`Format | `Numeric of range] }
+  ; action: [`Format] }
 
 let inputs =
   let dir = "_build/default/bench/test" in
@@ -31,13 +31,7 @@ let inputs =
     ; kind= Syntax.Structure
     ; source= source_ml
     ; conf= Conf.default
-    ; action= `Format }
-  ; { name= "numeric:conventional"
-    ; input_name= "source.ml"
-    ; kind= Syntax.Structure
-    ; source= source_ml
-    ; conf= Conf.default
-    ; action= `Numeric (10_000, 10_000) } ]
+    ; action= `Format } ]
 
 let tests =
   List.map
@@ -50,12 +44,7 @@ let tests =
         | `Format ->
             ignore
               (Translation_unit.parse_and_format kind ~input_name ~source
-                 conf )
-        | `Numeric range ->
-            let range = Range.make source ~range in
-            ignore
-              (Translation_unit.numeric kind ~input_name ~source ~range conf)
-        ) )
+                 conf ) ) )
     inputs
 
 let benchmark () =

bin/ocamlformat/main.ml

@@ -84,18 +84,6 @@ let run_action action =
       in
       Result.combine_errors_unit (List.map inputs ~f)
   | Print_config conf -> Conf.print_config conf ; Ok ()
-  | Numeric {kind; file; name= input_name; conf} ->
-      let conf =
-        { conf with
-          opr_opts=
-            { conf.opr_opts with
-              quiet= {v= true; from= conf.opr_opts.quiet.from} } }
-      in
-      let source = source_from_file file in
-      let range = conf.opr_opts.range.v source in
-      Translation_unit.numeric kind ~input_name ~source ~range conf
-      |> List.iter ~f:(fun i -> Stdio.print_endline (Int.to_string i)) ;
-      Ok ()
 ;;
 
 match Bin_conf.action () with

doc/manpage_ocamlformat.mld

@@ -600,11 +600,6 @@ OPTIONS
        --no-version-check
            Unset version-check.
 
-       --numeric
-           Instead of re-formatting the file, output one integer per line
-           corresponding to the indentation value, printing as many values as
-           lines in the document.
-
        -o DST, --output=DST
            Output file. Mutually exclusive with --inplace. Write to stdout if
            omitted.

emacs/ocamlformat.el

@@ -295,143 +295,6 @@ is nil."
       (delete-file bufferfile)
       (delete-file outputfile))))
 
-(defun ocamlformat-args (name start-line end-line)
-  (let*
-      ((margin-args
-        (cond
-         ((equal ocamlformat-margin-mode 'window)
-          (list "--margin" (number-to-string (window-body-width))))
-         ((equal ocamlformat-margin-mode 'fill)
-          (list "--margin" (number-to-string fill-column)))
-         (t
-          '())))
-       (enable-args
-        (cond
-         ((equal ocamlformat-enable 'disable)
-          (list "--disable"))
-         ((equal ocamlformat-enable 'enable-outside-detected-project)
-          (list "--enable-outside-detected-project"))
-         (t
-          '())))
-       (extension-args
-        (cond
-         ((eq ocamlformat-file-kind 'implementation)
-          (list "--impl"))
-         ((eq ocamlformat-file-kind 'interface)
-          (list "--intf")))))
-    (append margin-args enable-args extension-args
-            (list
-             "-"
-             "--name" name
-             "--numeric"
-             "--range" (format "%d-%d" start-line end-line)))))
-
-(defun ocamlformat-region (start end)
-  (interactive "r")
-  (let*
-      ((ext (file-name-extension buffer-file-name t))
-       (bufferfile (file-truename (make-temp-file "ocamlformat" nil ext)))
-       (errorfile (file-truename (make-temp-file "ocamlformat" nil ext)))
-       (errbuf
-        (cond
-         ((eq ocamlformat-show-errors 'buffer)
-          (get-buffer-create "*compilation*"))
-         ((eq ocamlformat-show-errors 'echo)
-          (get-buffer-create "*OCamlFormat stderr*"))))
-       (start-line (line-number-at-pos start))
-       (end-line (line-number-at-pos end))
-       (indents-str
-        (with-output-to-string
-          (if (/= 0
-                (apply 'call-process-region
-                       (point-min) (point-max) ocamlformat-command nil
-                       (list standard-output errorfile) nil
-                       (ocamlformat-args buffer-file-name start-line end-line)))
-              (progn
-                (if errbuf
-                  (progn
-                    (with-current-buffer errbuf
-                      (setq buffer-read-only nil)
-                      (erase-buffer))
-                    (ocamlformat--process-errors
-                     (buffer-file-name) bufferfile errorfile errbuf)))
-                (message "Could not apply ocamlformat")))))
-       (indents (mapcar 'string-to-number (split-string indents-str))))
-    (unwind-protect
-      (save-excursion
-        (goto-char start)
-        (mapcar
-         #'(lambda (indent) (indent-line-to indent) (forward-line))
-         indents))
-      (delete-file errorfile)
-      (delete-file bufferfile))))
-
-(defun ocamlformat-line ()
-  (interactive nil)
-  (ocamlformat-region (point) (point)))
-
-(defun ocamlformat--enable-indent ()
-  "Whether the indentation feature is enabled."
-  (version<= "0.19.0" (ocamlformat-version)))
-
-;;;###autoload
-(defun ocamlformat-setup-indent ()
-  (interactive nil)
-  (when (ocamlformat--enable-indent)
-    (setq-local indent-line-function #'ocamlformat-line)
-    (setq-local indent-region-function #'ocamlformat-region)))
-
-;;;###autoload
-(defun ocamlformat-caml-mode-setup ()
-  (ocamlformat-setup-indent)
-  (local-unset-key "\t"))  ;; caml-mode rebinds TAB !
-
-(defun ocamlformat-newline-and-indent (&optional arg)
-  "Insert a newline, then indent according to `ocamlformat-line'.
-With ARG, perform this action that many times."
-  (interactive "*p")
-  (delete-horizontal-space t)
-  (unless arg
-    (setq arg 1))
-  (dotimes (_ arg)
-    (newline nil t)
-    (insert "x")
-    (ocamlformat-line)
-    (delete-char -1)))
-
-(defun ocamlformat-set-newline-and-indent ()
-  "Bind RET to `ocamlformat-newline-and-indent'."
-  (when (ocamlformat--enable-indent)
-    (local-set-key (kbd "RET") 'ocamlformat-newline-and-indent)))
-
-(defun ocamlformat-version ()
-  "Get the version of the installed ocamlformat."
-  (car
-   (split-string
-    (shell-command-to-string
-     (format "%s --version" (shell-quote-argument ocamlformat-command)))
-    "-"
-    t
-    split-string-default-separators)))
-
-(defun ocamlformat--add-hooks ()
-  "Link ocamlformat with tuareg-mode and caml-mode."
-  (progn
-    (add-hook 'tuareg-mode-hook 'ocamlformat-setup-indent t)
-    (add-hook 'tuareg-mode-hook 'ocamlformat-set-newline-and-indent)
-    (add-hook 'caml-mode-hook 'ocamlformat-caml-mode-setup t)
-    (add-hook 'caml-mode-hook 'ocamlformat-set-newline-and-indent)))
-
-(pcase ocamlformat-enable
-  ;; never hook
-  ('disable '())
-  ;; always hook
-  ('enable-outside-detected-project (ocamlformat--add-hooks))
-  ;; only hook if there is an .ocamlformat file at the root of the project
-  ('enable
-   (if (vc-find-root default-directory ".ocamlformat")
-    (ocamlformat--add-hooks))))
-
 (provide 'ocamlformat)
 
 ;;; ocamlformat.el ends here

lib/Conf_t.mli

@@ -131,7 +131,7 @@ type opr_opts =
   ; ocaml_version: Ocaml_version.t elt
         (** Version of OCaml syntax of the output. *)
   ; quiet: bool elt
-  ; range: (string -> Range.t) elt
+  ; range: (string -> Range.t) elt  (** Unused. *)
   ; disable_conf_attrs: bool elt
   ; version_check: bool elt }