Add support for linting ECR files

README.md

@@ -174,6 +174,7 @@ In this example we define default globs and exclude `src/compiler` folder:
 ``` yaml
 Globs:
   - "**/*.cr"
+  - "**/*.ecr"
   - "!lib"
 
 Excluded:

spec/ameba/rule/layout/trailing_blank_lines_spec.cr

@@ -52,5 +52,12 @@ module Ameba::Rule::Layout
         issue.message.should eq "Trailing newline missing"
       end
     end
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      it "fails if there more then one blank line at the end of an ECR source" do
+        source = expect_issue subject, "a = 1\n \n # error: Excessive trailing newline detected", "source.ecr"
+        expect_no_corrections source
+      end
+    {% end %}
   end
 end

spec/ameba/rule/layout/trailing_whitespace_spec.cr

@@ -15,5 +15,16 @@ module Ameba::Rule::Layout
 
       expect_correction source, "whitespace at the end"
     end
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      it "fails if there is a line with trailing whitespace in an ECR file" do
+        source = expect_issue subject,
+          "whitespace at the end  \n" \
+          "                   # ^^ error: Trailing whitespace detected",
+          path: "source.ecr"
+
+        expect_correction source, "whitespace at the end"
+      end
+    {% end %}
   end
 end

spec/ameba/rule/lint/formatting_spec.cr

@@ -53,5 +53,18 @@ module Ameba::Rule::Lint
         end
       end
     end
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      it "passes ECR files regardless of formatting" do
+        source = expect_no_issues subject, <<-CRYSTAL, "source.ecr"
+          <%
+            def method(a,b,c=0)
+              a+b+c
+            end
+          %>
+
+          CRYSTAL
+      end
+    {% end %}
   end
 end

spec/ameba/rule/lint/literal_in_condition_spec.cr

@@ -175,5 +175,17 @@ module Ameba::Rule::Lint
       issue.end_location.to_s.should eq "source.cr:1:20"
       issue.message.should eq "Literal value found in conditional"
     end
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      it "fails if there is a predicate in if conditional in an ECR file" do
+        s = Source.new %(
+          <% if "string" %>
+            :ok
+          <% end %>
+        ), "source.ecr"
+
+        subject.catch(s).should_not be_valid
+      end
+    {% end %}
   end
 end

spec/ameba/rule/lint/unused_literal_spec.cr

@@ -295,5 +295,20 @@ module Ameba::Rule::Lint
             CRYSTAL
       end
     {% end %}
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      it "passes if a string is used in an assign directive in an ECR file" do
+        expect_no_issues subject, <<-CRYSTAL, path: "source.ecr"
+          <%= "hello world" %>
+          CRYSTAL
+      end
+
+      it "fails if a string is unused in an ECR file" do
+        expect_issue subject, <<-CRYSTAL, path: "source.ecr"
+          <% "hello world" %>
+           # ^^^^^^^^^^^^^ error: Literal value is not used
+          CRYSTAL
+      end
+    {% end %}
   end
 end

spec/ameba/source_spec.cr

@@ -70,5 +70,31 @@ module Ameba
           CRYSTAL
       end
     end
+
+    {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+      describe "#ast" do
+        it "parses an ECR file" do
+          source = Source.new <<-ECR, "filename.ecr"
+            hello <%= "world" %>
+            ECR
+
+          source.ast.to_s.should eq(<<-CRYSTAL)
+            __str__ << "hello "
+            ("world").to_s(__str__)
+
+            CRYSTAL
+        end
+
+        it "raises an exception when ECR parsing fails" do
+          source = Source.new <<-ECR, "filename.ecr"
+            hello <%= "world" >
+            ECR
+
+          expect_raises(Crystal::SyntaxException) do
+            source.ast
+          end
+        end
+      end
+    {% end %}
   end
 end

src/ameba/config.cr

@@ -1,5 +1,6 @@
 require "semantic_version"
 require "yaml"
+require "ecr/processor"
 require "./glob_utils"
 
 # A configuration entry for `Ameba::Runner`.
@@ -57,10 +58,18 @@ class Ameba::Config
     Path[XDG_CONFIG_HOME] / "ameba/config.yml",
   }
 
-  DEFAULT_GLOBS = %w(
-    **/*.cr
-    !lib
-  )
+  {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+    DEFAULT_GLOBS = %w(
+      **/*.cr
+      **/*.ecr
+      !lib
+    )
+  {% else %}
+    DEFAULT_GLOBS = %w(
+      **/*.cr
+      !lib
+    )
+  {% end %}
 
   getter rules : Array(Rule::Base)
   property severity = Severity::Convention
@@ -167,7 +176,7 @@ class Ameba::Config
   # ```
   # config = Ameba::Config.load
   # config.sources # => list of default sources
-  # config.globs = ["**/*.cr"]
+  # config.globs = ["**/*.cr", "**/*.ecr"]
   # config.excluded = ["spec"]
   # config.sources # => list of sources pointing to files found by the wildcards
   # ```

src/ameba/glob_utils.cr

@@ -24,7 +24,14 @@ module Ameba
     def expand(globs)
       globs
         .flat_map do |glob|
-          glob += "/**/*.cr" if File.directory?(glob)
+        if File.directory?(glob)
+          glob += "/**/*.cr"
+
+          {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+            glob += "/**/*.ecr"
+          {% end %}
+        end
+
           Dir[glob]
         end
         .uniq!

src/ameba/source.cr

@@ -57,6 +57,24 @@ module Ameba
     # source.ast
     # ```
     getter ast : Crystal::ASTNode do
+      code = @code
+
+      {% if compare_versions(Crystal::VERSION, "1.15.0") >= 0 %}
+        if @path.ends_with?(".ecr")
+          begin
+            code = ECR.process_string(code, @path)
+          rescue ex : ECR::Lexer::SyntaxException
+            # Need to rescue to add the filename
+            raise Crystal::SyntaxException.new(
+              ex.message,
+              ex.line_number,
+              ex.column_number,
+              @path
+            )
+          end
+        end
+      {% end %}
+
       Crystal::Parser.new(code)
         .tap(&.wants_doc = true)
         .tap(&.filename = path)