CI: add Github Action workflow for MacOS and Windows (ocaml-ppx#2055)

Author: Julow

.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: Build
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ocaml-compiler:
+          # Don't include every versions. OCaml-CI already covers that
+          - 4.13.x
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # Clone the project
+      - uses: actions/checkout@v2
+
+      # Setup
+      - name: Setup OCaml ${{ matrix.ocaml-version }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+      - name: Opam dependencies
+        run: opam install --deps-only -t .
+
+      - name: Runtest
+        run: opam exec -- dune runtest
+
+      - name: Check help files
+        run: opam exec -- dune build @help --auto-promote

lib/Eol_compat.ml

@@ -0,0 +1,41 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                              OCamlFormat                               *)
+(*                                                                        *)
+(*            Copyright (c) Facebook, Inc. and its affiliates.            *)
+(*                                                                        *)
+(*      This source code is licensed under the MIT license found in       *)
+(*      the LICENSE file in the root directory of this source tree.       *)
+(*                                                                        *)
+(**************************************************************************)
+
+let normalize_eol ?(exclude_locs = []) ~line_endings s =
+  let buf = Buffer.create (String.length s) in
+  let add_cr n = Buffer.add_string buf (String.make n '\r') in
+  let rec normalize_segment ~seen_cr i stop =
+    if i = stop then add_cr seen_cr
+    else
+      match s.[i] with
+      | '\r' -> normalize_segment ~seen_cr:(seen_cr + 1) (i + 1) stop
+      | '\n' ->
+          ( match line_endings with
+          | `Crlf -> Buffer.add_char buf '\r'
+          | `Lf -> () ) ;
+          Buffer.add_char buf '\n' ;
+          normalize_segment ~seen_cr:0 (i + 1) stop
+      | c ->
+          add_cr seen_cr ;
+          Buffer.add_char buf c ;
+          normalize_segment ~seen_cr:0 (i + 1) stop
+  in
+  let rec loop locs i =
+    match locs with
+    | [] ->
+        normalize_segment ~seen_cr:0 i (String.length s) ;
+        Buffer.contents buf
+    | (start, stop) :: xs ->
+        normalize_segment ~seen_cr:0 i start ;
+        Buffer.add_substring buf s ~pos:start ~len:(stop - start) ;
+        loop xs stop
+  in
+  loop exclude_locs 0

lib/Eol_compat.mli

@@ -0,0 +1,16 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                              OCamlFormat                               *)
+(*                                                                        *)
+(*            Copyright (c) Facebook, Inc. and its affiliates.            *)
+(*                                                                        *)
+(*      This source code is licensed under the MIT license found in       *)
+(*      the LICENSE file in the root directory of this source tree.       *)
+(*                                                                        *)
+(**************************************************************************)
+
+val normalize_eol :
+     ?exclude_locs:(int * int) list
+  -> line_endings:[`Crlf | `Lf]
+  -> string
+  -> string

lib/Toplevel_lexer.mll

@@ -16,7 +16,7 @@ open Migrate_ast
 let newline lexbuf = Lexing.new_line lexbuf
 }
 
-let eol = '\n'
+let eol = ('\013'* '\010')
 let ws = ' ' | '\t' | eol
 
 rule token = parse
@@ -42,11 +42,11 @@ and phrase buf = parse
   | eof      {
      let msg = "a toplevel phrase must end with `;;`." in
      raise (Syntaxerr.Error (Expecting (Location.curr lexbuf, msg))) }
-  | (("\n"* "\n") as nl) ("  " | "\t")
-      { for _ = 1 to (String.length nl) do
-          newline lexbuf
+  | ((eol* eol) as nl) ("  " | "\t")
+      { for _ = 1 to (Base.String.count ~f:(Char.equal '\n') nl) do
+          newline lexbuf;
+          Buffer.add_char buf '\n'
         done;
-        Buffer.add_string buf nl;
         phrase buf lexbuf }
   | ";;"     { Buffer.add_string buf ";;"; Buffer.contents buf }
   | _ as c   { Buffer.add_char buf c; phrase buf lexbuf }

lib/Translation_unit.ml

@@ -448,35 +448,6 @@ let parse_result ?disable_w50 f fragment conf ~source ~input_name =
   | exception exn -> Error (Error.Invalid_source {exn; input_name})
   | parsed -> Ok parsed
 
-let normalize_eol ~strlocs ~line_endings s =
-  let buf = Buffer.create (String.length s) in
-  let add_cr n = Buffer.add_string buf (String.init n ~f:(fun _ -> '\r')) in
-  let rec normalize_segment ~seen_cr i stop =
-    if i = stop then add_cr seen_cr
-    else
-      match s.[i] with
-      | '\r' -> normalize_segment ~seen_cr:(seen_cr + 1) (i + 1) stop
-      | '\n' ->
-          Buffer.add_string buf
-            (match line_endings with `Crlf -> "\r\n" | `Lf -> "\n") ;
-          normalize_segment ~seen_cr:0 (i + 1) stop
-      | c ->
-          add_cr seen_cr ;
-          Buffer.add_char buf c ;
-          normalize_segment ~seen_cr:0 (i + 1) stop
-  in
-  let rec loop locs i =
-    match locs with
-    | [] ->
-        normalize_segment ~seen_cr:0 i (String.length s) ;
-        Buffer.contents buf
-    | (start, stop) :: xs ->
-        normalize_segment ~seen_cr:0 i start ;
-        Buffer.add_substring buf s ~pos:start ~len:(stop - start) ;
-        loop xs stop
-  in
-  loop strlocs 0
-
 let parse_and_format (type a b) (fg : a Extended_ast.t)
     (std_fg : b Std_ast.t) ?output_file ~input_name ~source (conf : Conf.t) =
   Location.input_name := input_name ;
@@ -493,7 +464,7 @@ let parse_and_format (type a b) (fg : a Extended_ast.t)
     format fg std_fg ?output_file ~input_name ~prev_source:source ~parsed
       ~std_parsed conf
   in
-  Ok (normalize_eol ~strlocs ~line_endings formatted)
+  Ok (Eol_compat.normalize_eol ~exclude_locs:strlocs ~line_endings formatted)
 
 let parse_and_format = function
   | Syntax.Structure -> parse_and_format Structure Structure

test/cli/dune

@@ -3,6 +3,6 @@
  (deps %{bin:ocamlformat}))
 
 (cram
- (applies_to large_string)
+ (applies_to large_string conf removed_option repl_file_errors)
  (enabled_if
   (<> %{os_type} Win32)))

test/failing/dune

@@ -4,6 +4,8 @@
  (deps
   (source_tree .))
  (package ocamlformat)
+ (enabled_if
+  (<> %{os_type} Win32))
  (action
   (with-stdout-to
    dune.inc.gen
@@ -12,5 +14,7 @@
 (rule
  (alias runtest)
  (package ocamlformat)
+ (enabled_if
+  (<> %{os_type} Win32))
  (action
   (diff dune.inc dune.inc.gen)))

test/passing/dune

@@ -4,6 +4,8 @@
  (deps
   (source_tree .))
  (package ocamlformat)
+ (enabled_if
+  (<> %{os_type} Win32))
  (action
   (with-stdout-to
    dune.inc.gen
@@ -12,5 +14,7 @@
 (rule
  (alias runtest)
  (package ocamlformat)
+ (enabled_if
+  (<> %{os_type} Win32))
  (action
   (diff dune.inc dune.inc.gen)))