Add sass-rails linter to ensure webpacker compatibility

sgara · sgara · commit 338bd33a7e85 · 2019-11-05T10:19:26.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -64,6 +64,9 @@ you use the correct Gemfile, for example:
 export BUNDLE_GEMFILE=gemfiles/rails_51.gemfile
 ```
 
+**Warning** SCSS assets are aimed to be used indifferently with Sprockets **and** webpacker.
+As such, make sure not to use any sass-rails directives such as `asset-url` or `image-url`.
+
 ### Did you find a bug?
 
 * **Ensure the bug was not already reported** by [searching all issues].
diff --git a/tasks/lint.rake b/tasks/lint.rake
@@ -88,8 +88,25 @@ class FixmeLinter
   end
 end
 
+#
+# Checks sass-rails directives
+#
+class SassRailsLinter
+  include LinterMixin
+
+  def applicable_files
+    Dir["app/assets/stylesheets/**/*.scss"]
+  end
+
+  def clean?(file)
+    relative_path = Pathname.new(__FILE__).relative_path_from(Pathname.new(File.dirname(__dir__))).to_s
+
+    file == relative_path || File.read(file, encoding: Encoding::UTF_8) !~ /(asset-url|asset-path|image-url|image-path|asset-data-url)/
+  end
+end
+
 desc "Lints ActiveAdmin code base"
-task lint: ["lint:rubocop", "lint:mdl", "lint:gherkin_lint", "lint:trailing_blank_lines", "lint:missing_final_new_line", "lint:trailing_whitespace", "lint:fixme", "lint:rspec"]
+task lint: ["lint:rubocop", "lint:mdl", "lint:gherkin_lint", "lint:trailing_blank_lines", "lint:missing_final_new_line", "lint:trailing_whitespace", "lint:fixme", "lint:sass_rails", "lint:rspec"]
 
 namespace :lint do
   require "rubocop/rake_task"
@@ -138,6 +155,13 @@ namespace :lint do
     FixmeLinter.new.run
   end
 
+  desc "Check for sass-rails directives to ensure webpacker compatibility"
+  task :sass_rails do
+    puts ""
+
+    SassRailsLinter.new.run
+  end
+
   desc "RSpec specs for linting project files"
   task :rspec do
     puts "Linting project files..."
