Merge branch 'MAIN' into pr/2715

Author: Julow

doc/manpage_ocamlformat.mld

@@ -471,16 +471,16 @@ OPTIONS (CODE FORMATTING STYLE)
            Style for function call. The flag is set by default.
 
 OPTIONS (REMOVED)
-       --align-cases=VAL
+       --align-cases=VALUE
            This option has been removed in version 0.22.
 
-       --align-constructors-decl=VAL
+       --align-constructors-decl=VALUE
            This option has been removed in version 0.22.
 
-       --align-variants-decl=VAL
+       --align-variants-decl=VALUE
            This option has been removed in version 0.22.
 
-       --doc-comments-val=VAL
+       --doc-comments-val=VALUE
            This option has been removed in version 0.16. If you are using
            `doc-comments-val=before` in combination with
            `doc-comments=before` then only `doc-comments=before` is now
@@ -495,27 +495,27 @@ OPTIONS (REMOVED)
            `doc-comments-val=unset` the same behavior can now be achieved by
            setting `doc-comments` only.
 
-       --escape-chars=VAL
+       --escape-chars=VALUE
            This option has been removed in version 0.16. Concrete syntax will
            now always be preserved.
 
-       --escape-strings=VAL
+       --escape-strings=VALUE
            This option has been removed in version 0.16. Concrete syntax will
            now always be preserved.
 
-       --extension-sugar=VAL
+       --extension-sugar=VALUE
            This option has been removed in version 0.17. Concrete syntax will
            now always be preserved.
 
-       --let-open=VAL
+       --let-open=VALUE
            This option has been removed in version 0.17. Concrete syntax will
            now always be preserved.
 
 OPTIONS
        Unless mentioned otherwise non-formatting options cannot be set in
        attributes or .ocamlformat files.
 
-       -c VAL, --config=VAL (absent OCAMLFORMAT env)
+       -c =[,…], --config==[,…] (absent OCAMLFORMAT env)
            Aggregate options. Options are specified as a comma-separated list
            of pairs: option=VAL,...,option=VAL.
 

test/cli/conf.t

@@ -13,45 +13,34 @@ Invalid version:
 
 Exit code is printed by hand because sed succeeding would hide the error.
 
-  $ (<a.ml ocamlformat --impl -; echo [$?]) 2>&1 | sed 's/version is "[^"]*"/version is "..."/g'
-  ocamlformat: Error while parsing $TESTCASE_ROOT/prj/.ocamlformat:
-               Project should be formatted using ocamlformat version "bad", but the installed version is "..."
+  $ <a.ml ocamlformat --impl - 2>/dev/null
   [1]
 
 Disable version check:
 
-  $ (<a.ml ocamlformat --impl --no-version-check -; echo [$?]) 2>&1
+  $ <a.ml ocamlformat --impl --no-version-check -
   let x = "Hello World"
-  [0]
 
 Invalid syntax in .ocamlformat file:
 
   $ echo 'a = b = c' > .ocamlformat
-  $ echo 'let x = 1"' | ocamlformat --impl -
-  ocamlformat: Error while parsing $TESTCASE_ROOT/prj/.ocamlformat:
-               Invalid format "a = b = c"
+  $ echo 'let x = 1"' | ocamlformat --impl - 2>/dev/null
   [1]
 
 Invalid option:
 
   $ echo 'unknown_option = true' > .ocamlformat
-  $ echo 'let x = 1' | ocamlformat --impl -
-  ocamlformat: Error while parsing $TESTCASE_ROOT/prj/.ocamlformat:
-               Unknown option "unknown_option"
+  $ echo 'let x = 1' | ocamlformat --impl - 2>/dev/null
   [1]
 
 Invalid option (short negated form):
 
   $ echo 'no-wrap-comments' > .ocamlformat
-  $ echo 'let x = 1' | ocamlformat --impl -
-  ocamlformat: Error while parsing $TESTCASE_ROOT/prj/.ocamlformat:
-               Unknown option "no-wrap-comments": "no-wrap-comments" is the short form for "wrap-comments=false". It is only accepted on command line, please use "wrap-comments=false" or "wrap-comments=true" instead.
+  $ echo 'let x = 1' | ocamlformat --impl - 2>/dev/null
   [1]
 
 Invalid value:
 
   $ echo 'field-space = unknown_value' > .ocamlformat
-  $ echo 'let x = 1' | ocamlformat --impl -
-  ocamlformat: Error while parsing $TESTCASE_ROOT/prj/.ocamlformat:
-               For option "field-space": invalid value 'unknown_value', expected one of 'loose', 'tight' or 'tight-decl'
+  $ echo 'let x = 1' | ocamlformat --impl - 2>/dev/null
   [1]

test/cli/dune

@@ -6,3 +6,10 @@
  (applies_to large_string conf removed_option repl_file_errors debug)
  (enabled_if
   (<> %{os_type} Win32)))
+
+; Avoid unstable output from Cmdliner
+
+(env
+ (_
+  (env-vars
+   (TERM dumb))))

test/cli/env.t

@@ -1,13 +1,9 @@
 Invalid option:
 
-  $ echo 'let x = 1' | OCAMLFORMAT="unknown=true" ocamlformat --impl -
-  ocamlformat: Error while parsing OCAMLFORMAT environment variable:
-               Unknown option "unknown"
+  $ echo 'let x = 1' | OCAMLFORMAT="unknown=true" ocamlformat --impl - 2>/dev/null
   [1]
 
 Invalid value:
 
-  $ echo 'let x = 1' | OCAMLFORMAT="type-decl=unknown" ocamlformat --impl -
-  ocamlformat: Error while parsing OCAMLFORMAT environment variable:
-               For option "type-decl": invalid value 'unknown', expected either 'compact' or 'sparse'
+  $ echo 'let x = 1' | OCAMLFORMAT="type-decl=unknown" ocamlformat --impl - 2>/dev/null
   [1]

test/cli/removed_option.t

@@ -2,78 +2,11 @@
 
 Setting a removed option on the command line should display an error message:
 
-  $ ocamlformat a.ml --extension-sugar preserve
-  ocamlformat: option '--extension-sugar': This option has been removed in
-               version 0.17. Concrete syntax will now always be preserved.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
-  [1]
-
-  $ ocamlformat a.ml --let-open preserve
-  ocamlformat: option '--let-open': This option has been removed in version
-               0.17. Concrete syntax will now always be preserved.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
-  [1]
-
-  $ ocamlformat a.ml --escape-chars preserve
-  ocamlformat: option '--escape-chars': This option has been removed in version
-               0.16. Concrete syntax will now always be preserved.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
-  [1]
-
-  $ ocamlformat a.ml --escape-strings preserve
-  ocamlformat: option '--escape-strings': This option has been removed in
-               version 0.16. Concrete syntax will now always be preserved.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
-  [1]
-
-  $ ocamlformat a.ml --doc-comments-val unset
-  ocamlformat: option '--doc-comments-val': This option has been removed in
-               version 0.16. If you are using `doc-comments-val=before` in
-               combination with `doc-comments=before` then only
-               `doc-comments=before` is now required to achive the same
-               behavior. If you are using `doc-comments-val=before` in
-               combination with `doc-comments=after` this behavior is not
-               available anymore. If you are using `doc-comments-val=after` in
-               combination with `doc-comments=before` please now use
-               `doc-comments=before-except-val`. If you are using
-               `doc-comments-val=after` in combination with
-               `doc-comments=after` then only
-               `doc-comments=after-when-possible` is now required to achieve
-               the same behavior. If you are using `doc-comments-val=unset` the
-               same behavior can now be achieved by setting `doc-comments`
-               only.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
+  $ ocamlformat a.ml --extension-sugar preserve 2>/dev/null
   [1]
 
 An error is also reported if a removed option is set in an .ocamlformat file:
 
   $ echo 'escape-chars = preserve' > .ocamlformat
-  $ ocamlformat a.ml
-  ocamlformat: Error while parsing $TESTCASE_ROOT/.ocamlformat:
-               For option "escape-chars": This option has been removed in version 0.16. Concrete syntax will now always be preserved.
-  [1]
-
-Setting an option to a deprecated value on the command line should also display an error message:
-
-  $ ocamlformat a.ml --break-separators=after-and-docked
-  ocamlformat: option '--break-separators': value `after-and-docked` has been
-               removed in version 0.12. One can get a similar behaviour by
-               setting `break-separators=after`, `space-around-lists=false`,
-               and `dock-collection-brackets=false`.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
-  [1]
-
-  $ ocamlformat a.ml --break-string-literals=wrap
-  ocamlformat: option '--break-string-literals': value `wrap` has been removed
-               in version 0.12. It has been replaced by the new default `auto`
-               value, which breaks lines at newlines and wraps string literals
-               at the margin.
-  Usage: ocamlformat [OPTION]… [SRC]…
-  Try 'ocamlformat --help' for more information.
+  $ ocamlformat a.ml 2>/dev/null
   [1]

test/cli/stdin.t

@@ -2,16 +2,10 @@
 
 One of '--impl', '--intf' or '--name' is required when the input is read from stdin:
 
-  $ ocamlformat -
-  ocamlformat: Must specify at least one of --name, --impl or --intf when reading from stdin
+  $ echo 'let x = 1' | ocamlformat - 2>/dev/null
   [1]
 
-  $ echo 'let x =       1' | ocamlformat -
-  ocamlformat: Must specify at least one of --name, --impl or --intf when reading from stdin
-  [1]
-
-  $ ocamlformat --inplace -
-  ocamlformat: Must specify at least one of --name, --impl or --intf when reading from stdin
+  $ echo 'let x = 1' | ocamlformat --inplace - 2>/dev/null
   [1]
 
 Nominal cases:
@@ -29,15 +23,13 @@ The kind of syntax --impl/--intf is inferred from the name:
 
 The syntax cannot be inferred if the extension of the file is unsupported:
 
-  $ ocamlformat --name a.cpp -
-  ocamlformat: Cannot deduce file kind from passed --name. Please specify --impl or --intf
+  $ ocamlformat --name a.cpp - 2>/dev/null
   [1]
 
 Cannot specify files with stdin:
 
   $ echo 'let x = 1' > a.ml
-  $ ocamlformat a.ml -
-  ocamlformat: Cannot specify stdin together with other inputs
+  $ ocamlformat a.ml - 2>/dev/null
   [1]
 
 The input is named after the '--name' argument in formatting error messages:

test/passing/gen/dune.inc

@@ -4480,24 +4480,6 @@
  (package ocamlformat)
  (action (diff open_types.ml.err open_types.ml.stderr)))
 
-(rule
- (deps .ocamlformat)
- (package ocamlformat)
- (action
-  (with-stdout-to option.ml.stdout
-   (with-stderr-to option.ml.stderr
-     (run %{bin:ocamlformat} --name option.ml --margin-check %{dep:../tests/option.ml})))))
-
-(rule
- (alias runtest)
- (package ocamlformat)
- (action (diff option.ml.ref option.ml.stdout)))
-
-(rule
- (alias runtest)
- (package ocamlformat)
- (action (diff option.ml.err option.ml.stderr)))
-
 (rule
  (deps .ocamlformat)
  (package ocamlformat)

test/passing/refs.ahrefs/option.ml.err

@@ -20,10 +20,12 @@ File "option.ml", line 28, characters 3-14:
 28 | [@@ocamlformat "if-then-else=bad"]
         ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'
 
 File "option.ml", line 39, characters 14-25:
 39 |            [@@ocamlformat "if-then-else=bad"]
                    ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'

test/passing/refs.default/option.ml.err

@@ -20,10 +20,12 @@ File "option.ml", line 28, characters 3-14:
 28 | [@@ocamlformat "if-then-else=bad"]
         ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'
 
 File "option.ml", line 39, characters 14-25:
 39 |            [@@ocamlformat "if-then-else=bad"]
                    ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'

test/passing/refs.janestreet/option.ml.err

@@ -20,10 +20,12 @@ File "option.ml", line 28, characters 3-14:
 28 | [@@ocamlformat "if-then-else=bad"]
         ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'
 
 File "option.ml", line 39, characters 14-25:
 39 |            [@@ocamlformat "if-then-else=bad"]
                    ^^^^^^^^^^^
 Warning 47 [attribute-payload]: illegal payload for attribute 'ocamlformat'.
-For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical', 'vertical', 'keyword-first' or 'k-r'
+For option "if-then-else": invalid value 'bad', expected one of 'compact', 'fit-or-vertical',
+'vertical', 'keyword-first' or 'k-r'