Finish stdio input & add tests

Author: michalmuskala

src/erlfmt.erl

@@ -63,20 +63,17 @@ init(State) ->
 
 %% API entry point
 -spec format_file(file:name_all() | stdin, config()) ->
-    {ok, [error_info()]} | {error, error_info()}.
+    {ok, [error_info()]} | skip | {error, error_info()}.
 format_file(FileName, {Pragma, Out}) ->
     try
-        %% TODO: fix for stdin
-        ShouldFormat = (Pragma == ignore) orelse contains_pragma_file(FileName),
-        case ShouldFormat of
-            true ->
-                {ok, Nodes, Warnings} = file_read_nodes(FileName),
+        case file_read_nodes(FileName, Pragma) of
+            {ok, Nodes, Warnings} ->
                 [$\n | Formatted] = format_nodes(Nodes),
                 verify_nodes(FileName, Nodes, Formatted),
                 write_formatted(FileName, Formatted, Out),
                 {ok, Warnings};
-            false ->
-                {ok, []}
+            skip ->
+                skip
         end
     catch
         {error, Error} -> {error, Error}
@@ -119,7 +116,7 @@ contains_pragma_comment(_) ->
     {options, [{erlfmt_scan:location(), erlfmt_scan:location()}]}.
 format_range(FileName, StartLocation, EndLocation) ->
     try
-        {ok, Nodes, Warnings} = file_read_nodes(FileName),
+        {ok, Nodes, Warnings} = file_read_nodes(FileName, ignore),
         case verify_ranges(Nodes, StartLocation, EndLocation) of
             {ok, NodesInRange} ->
                 [$\n | Result] = format_nodes(NodesInRange),
@@ -136,14 +133,14 @@ format_range(FileName, StartLocation, EndLocation) ->
 -spec read_nodes(file:name_all()) ->
     {ok, [erlfmt_parse:abstract_form()], [error_info()]} | {error, error_info()}.
 read_nodes(FileName) ->
-    try file_read_nodes(FileName)
+    try file_read_nodes(FileName, ignore)
     catch
         {error, Error} -> {error, Error}
     end.
 
-file_read_nodes(FileName) ->
+file_read_nodes(FileName, Pragma) ->
     read_file(FileName, fun (File) ->
-        read_nodes(erlfmt_scan:io_node(File), FileName, [], [])
+        read_nodes(erlfmt_scan:io_node(File), FileName, Pragma)
     end).
 
 read_file(stdin, Action) ->
@@ -162,17 +159,28 @@ read_file(FileName, Action) ->
 -spec read_nodes_string(file:name_all(), string()) ->
     {ok, [erlfmt_parse:abstract_form()], [error_info()]} | {error, error_info()}.
 read_nodes_string(FileName, String) ->
-    try read_nodes(erlfmt_scan:string_node(String), FileName, [], [])
+    try read_nodes(erlfmt_scan:string_node(String), FileName, ignore)
     catch
         {error, Error} -> {error, Error}
     end.
 
-read_nodes({ok, Tokens, Comments, Cont}, FileName, Acc, Warnings0) ->
+read_nodes({ok, Tokens, Comments, Cont}, FileName, Pragma) ->
+    {Node, Warnings} = parse_nodes(Tokens, Comments, FileName, Cont, []),
+    case contains_pragma_node(Node) of
+        false when Pragma =:= require ->
+            skip;
+        _ ->
+            read_nodes_loop(erlfmt_scan:continue(Cont), FileName, [Node], Warnings)
+    end;
+read_nodes(Other, FileName, _Pragma) ->
+    read_nodes_loop(Other, FileName, [], []).
+
+read_nodes_loop({ok, Tokens, Comments, Cont}, FileName, Acc, Warnings0) ->
     {Node, Warnings} = parse_nodes(Tokens, Comments, FileName, Cont, Warnings0),
-    read_nodes(erlfmt_scan:continue(Cont), FileName, [Node | Acc], Warnings);
-read_nodes({eof, _Loc}, _FileName, Acc, Warnings) ->
+    read_nodes_loop(erlfmt_scan:continue(Cont), FileName, [Node | Acc], Warnings);
+read_nodes_loop({eof, _Loc}, _FileName, Acc, Warnings) ->
     {ok, lists:reverse(Acc), lists:reverse(Warnings)};
-read_nodes({error, {ErrLoc, Mod, Reason}, _Loc}, FileName, _Acc, _Warnings) ->
+read_nodes_loop({error, {ErrLoc, Mod, Reason}, _Loc}, FileName, _Acc, _Warnings) ->
     throw({error, {FileName, ErrLoc, Mod, Reason}}).
 
 parse_nodes([], _Comments, _FileName, Cont, Warnings) ->

src/erlfmt_cli.erl

@@ -64,6 +64,11 @@ format_files([FileName | FileNames], Config, HadErrors) ->
         {ok, Warnings} ->
             [print_error_info(Warning) || Warning <- Warnings],
             format_files(FileNames, Config, HadErrors);
+        skip when Config#config.verbose ->
+            io:format(standard_error, "Skipping ~s because of missing @format pragma\n", [FileName]),
+            format_files(FileNames, Config, HadErrors);
+        skip ->
+            format_files(FileNames, Config, HadErrors);
         {error, Error} ->
             print_error_info(Error),
             format_files(FileNames, Config, true)
@@ -88,6 +93,8 @@ parse_opts([require_pragma | Rest], Name, Files, Config) ->
     parse_opts(Rest, Name, Files, Config#config{require_pragma = true});
 parse_opts([{files, NewFiles} | Rest], Name, Files0, Config) ->
     parse_opts(Rest, Name, expand_files(NewFiles, Files0), Config);
+parse_opts([], _Name, [stdin], #config{out = Out}) when Out =/= standard_out ->
+    {error, "stdin mode can't be combined with out or write options"};
 parse_opts([], _Name, [stdin], Config) ->
     {format, [stdin], Config};
 parse_opts([], _Name, [], _Config) ->

test/erlfmt_SUITE.erl

@@ -48,6 +48,10 @@
     annos/1,
     shebang/1,
     smoke_test_cli/1,
+    smoke_test_stdio_escript/1,
+    smoke_test_stdio_regular/1,
+    smoke_test_stdio_without_pragma/1,
+    smoke_test_stdio_with_pragma/1,
     snapshot_simple_comments/1,
     snapshot_big_binary/1,
     snapshot_attributes/1,
@@ -104,7 +108,11 @@ groups() ->
         ]},
         {smoke_tests, [parallel], [
             {group, snapshot_tests},
-            smoke_test_cli
+            smoke_test_cli,
+            smoke_test_stdio_escript,
+            smoke_test_stdio_regular,
+            smoke_test_stdio_without_pragma,
+            smoke_test_stdio_with_pragma
         ]},
         {snapshot_tests, [parallel], [
             snapshot_simple_comments,
@@ -918,9 +926,38 @@ parse_forms(String) ->
     end.
 
 smoke_test_cli(Config) when is_list(Config) ->
+    ?assertMatch("Usage: erlfmt " ++ _, os:cmd(escript() ++ " -h")).
+
+smoke_test_stdio_escript(Config) when is_list(Config) ->
+    DataDir = ?config(data_dir, Config),
+    Path = filename:join(DataDir, "escript.erl"),
+    Formatted = os:cmd("cat " ++ Path ++ " | " ++ escript() ++ " -"),
+    {ok, Expected} = file:read_file(Path),
+    ?assertEqual(Expected, unicode:characters_to_binary(Formatted)).
+
+smoke_test_stdio_regular(Config) when is_list(Config) ->
+    DataDir = ?config(data_dir, Config),
+    Path = filename:join(DataDir, "attributes.erl"),
+    Formatted = os:cmd("cat " ++ Path ++ " | " ++ escript() ++ " -"),
+    {ok, Expected} = file:read_file(Path),
+    ?assertEqual(Expected, unicode:characters_to_binary(Formatted)).
+
+smoke_test_stdio_without_pragma(Config) when is_list(Config) ->
+    DataDir = ?config(data_dir, Config),
+    Path = filename:join(DataDir, "big_binary.erl"),
+    Formatted = os:cmd("cat " ++ Path ++ " | " ++ escript() ++ " - --require-pragma"),
+    ?assertEqual("", Formatted).
+
+smoke_test_stdio_with_pragma(Config) when is_list(Config) ->
+    DataDir = ?config(data_dir, Config),
+    Path = filename:join(DataDir, "pragma.erl"),
+    Formatted= os:cmd("cat " ++ Path ++ " | " ++ escript() ++ " - --require-pragma"),
+    {ok, Expected} = file:read_file(Path),
+    ?assertEqual(Expected, unicode:characters_to_binary(Formatted)).
+
+escript() ->
     %% this relies on the _build structure rebar3 uses
-    Escript = filename:join(code:lib_dir(erlfmt), "../../bin/erlfmt"),
-    ?assertMatch("Usage: erlfmt " ++ _, os:cmd(Escript ++ " -h")).
+    filename:join(code:lib_dir(erlfmt), "../../bin/erlfmt").
 
 snapshot_simple_comments(Config) -> snapshot_same("simple_comments.erl", Config).
 

test/erlfmt_SUITE_data/pragma.erl

@@ -0,0 +1,3 @@
+%% @format
+
+-module(pragma).