scss-lint 0.36.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3a2b1ee0f782f66cb555280a0b7be06a2a4ff5f
-  data.tar.gz: 9b92adbf68a21311695432d0357ea6805b632be1
+  metadata.gz: 4643e39c19004b8de6167f9ad88d9aa9458c7152
+  data.tar.gz: 0500e517334acc90a14da0cf0f51b8dcd34f91b9
 SHA512:
-  metadata.gz: 01b85e9caee70645b1cc8da766b24cf0a5db2bca10c0d5fe1fd004492c27605a8cf08b194298dc20e5f0e1d6f56376fc68f4a4889df62e90295f7be36e88e1ec
-  data.tar.gz: 96aafd6d3d5a8fb34d99aebbf0f15ffe8216f482e785ff157266f9d1fa3dcff4014b53ef43aee95c11881d21a93cd047c6e3f767206c64e1ef62150c5b751fe5
+  metadata.gz: 5ca899f683ea5d88e5dbfb79bbeaccb8a41491870d8ead470495bd06b5e9c01a801f580b5b4a0df34ee1e43f31c397f39f5acadd9047cb5f59a8d9c2e8d5292b
+  data.tar.gz: 90783696031b8c29422d95dd35676bb9ce27addf33be7cf1e163509ab40bb60952b7ff83ec52b2d0b122825eaeeff0fcb01c4cf16205981bec88a6bd33df0116

data/config/default.yml

@@ -84,7 +84,7 @@ linters:
   NameFormat:
     enabled: true
     allow_leading_underscore: true
-    convention: hyphenated_lowercase # or 'BEM', or a regex pattern
+    convention: hyphenated_lowercase # or 'camel_case', or 'snake_case', or a regex pattern
 
   NestingDepth:
     enabled: true
@@ -133,7 +133,7 @@ linters:
 
   SelectorFormat:
     enabled: true
-    convention: hyphenated_lowercase # or 'BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
+    convention: hyphenated_lowercase # or 'strict_BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
 
   Shorthand:
     enabled: true

data/lib/scss_lint/linter/name_format.rb

@@ -1,6 +1,6 @@
 module SCSSLint
-  # Checks that the declared names of functions, mixins, and variables are all
-  # lowercase and use hyphens instead of underscores.
+  # Checks the format of declared names of functions, mixins, variables, and
+  # placeholders.
   class Linter::NameFormat < Linter
     include LinterRegistry
 
@@ -47,10 +47,10 @@ module SCSSLint
 
     def check_name(node, node_type, node_text = node.name)
       node_text = trim_underscore_prefix(node_text)
-      return unless violation = violated_convention(node_text)
+      return unless violation = violated_convention(node_text, node_type)
 
-      add_lint(node, "Name of #{node_type} `#{node_text}` should be " \
-                     "written #{violation[:explanation]}")
+      add_lint(node,
+               "Name of #{node_type} `#{node_text}` #{violation[:explanation]}")
     end
 
     # Removes underscore prefix from name if leading underscores are allowed.
@@ -70,26 +70,48 @@ module SCSSLint
     end
 
     CONVENTIONS = {
+      'camel_case' => {
+        explanation: 'should be written in camelCase format',
+        validator: ->(name) { name =~ /^[a-z][a-zA-Z0-9]*$/ },
+      },
+      'snake_case' => {
+        explanation: 'should be written in snake_case',
+        validator: ->(name) { name !~ /[^_a-z0-9]/ },
+      },
       'hyphenated_lowercase' => {
-        explanation: 'in all lowercase letters with hyphens instead of underscores',
+        explanation: 'should be written in all lowercase letters with hyphens ' \
+                     'instead of underscores',
         validator: ->(name) { name !~ /[_A-Z]/ },
       },
-      'BEM' => {
-        explanation: 'in BEM (Block Element Modifier) format',
-        validator: ->(name) { name !~ /[A-Z]|-{3}|_{3}|[^_]_[^_]/ },
-      },
     }
 
-    # Checks the given name and returns the violated convention if it failed.
-    def violated_convention(name_string)
-      convention_name = config['convention'] || 'hyphenated_lowercase'
+    def violated_convention(name_string, type)
+      convention_name = convention_name(type)
 
-      convention = CONVENTIONS[convention_name] || {
-        explanation: "must match regex /#{convention_name}/",
+      existing_convention = CONVENTIONS[convention_name]
+
+      convention = (existing_convention || {
         validator: ->(name) { name =~ /#{convention_name}/ }
-      }
+      }).merge(
+        explanation: convention_explanation(type), # Allow explanation to be customized
+      )
 
       convention unless convention[:validator].call(name_string)
     end
+
+    def convention_name(type)
+      config["#{type}_convention"] ||
+        config['convention'] ||
+        'hyphenated_lowercase'
+    end
+
+    def convention_explanation(type)
+      existing_convention = CONVENTIONS[convention_name(type)]
+
+      config["#{type}_convention_explanation"] ||
+        config['convention_explanation'] ||
+        (existing_convention && existing_convention[:explanation]) ||
+        "should match regex /#{convention_name(type)}/"
+    end
   end
 end

data/lib/scss_lint/linter/selector_format.rb

@@ -57,7 +57,7 @@ module SCSSLint
         explanation: 'should be written in hyphenated BEM (Block Element Modifier) format',
         validator: ->(name) { name !~ /[A-Z]|-{3}|_{3}|[^_]_[^_]/ },
       },
-      'BEM' => {
+      'strict_BEM' => {
         explanation: 'should be written in BEM (Block Element Modifier) format',
         validator: lambda do |name|
           name =~ /
@@ -71,16 +71,32 @@ module SCSSLint
 
     # Checks the given name and returns the violated convention if it failed.
     def violated_convention(name_string, type)
-      convention_name = config["#{type}_convention"] ||
-                        config['convention'] ||
-                        'hyphenated_lowercase'
+      convention_name = convention_name(type)
 
-      convention = CONVENTIONS[convention_name] || {
-        explanation: "should match regex /#{convention_name}/",
+      existing_convention = CONVENTIONS[convention_name]
+
+      convention = (existing_convention || {
         validator: ->(name) { name =~ /#{convention_name}/ }
-      }
+      }).merge(
+        explanation: convention_explanation(type), # Allow explanation to be customized
+      )
 
       convention unless convention[:validator].call(name_string)
     end
+
+    def convention_name(type)
+      config["#{type}_convention"] ||
+        config['convention'] ||
+        'hyphenated_lowercase'
+    end
+
+    def convention_explanation(type)
+      existing_convention = CONVENTIONS[convention_name(type)]
+
+      config["#{type}_convention_explanation"] ||
+        config['convention_explanation'] ||
+        (existing_convention && existing_convention[:explanation]) ||
+        "should match regex /#{convention_name(type)}/"
+    end
   end
 end

data/lib/scss_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SCSSLint
-  VERSION = '0.36.1'
+  VERSION = '0.37.0'
 end

data/spec/scss_lint/linter/name_format_spec.rb

@@ -194,75 +194,87 @@ describe SCSSLint::Linter::NameFormat do
     end
   end
 
-  context 'when the BEM convention is specified' do
-    let(:linter_config) { { 'convention' => 'BEM' } }
+  context 'when the camel_case convention is specified' do
+    let(:linter_config) { { 'convention' => 'camel_case' } }
 
-    context 'when a name contains no underscores or hyphens' do
-      let(:scss) { '@extend %block;' }
+    context 'when a name contains all lowercase letters' do
+      let(:scss) { '$variable: 1;' }
 
       it { should_not report_lint }
     end
 
-    context 'when a name contains a single underscore' do
-      let(:scss) { '@extend %block_thing;' }
+    context 'when a name contains all lowercase letters and underscores' do
+      let(:scss) { '$my_variable: 1;' }
 
       it { should report_lint }
     end
 
-    context 'when a name contains a single hyphen' do
-      let(:scss) { '@extend %block-thing;' }
+    context 'when a name contains all lowercase letters and hyphens' do
+      let(:scss) { '$my-variable: 1;' }
 
-      it { should_not report_lint }
+      it { should report_lint }
     end
 
-    context 'when a name contains a double hyphen' do
-      let(:scss) { '@extend %block--thing;' }
+    context 'when a name is written in camelCase' do
+      let(:scss) { '$myVariable: 1;' }
 
       it { should_not report_lint }
     end
+  end
 
-    context 'when a name contains a double underscore' do
-      let(:scss) { '@extend %block__thing;' }
+  context 'when the snake_case convention is specified' do
+    let(:linter_config) { { 'convention' => 'snake_case' } }
+
+    context 'when a name contains all lowercase letters' do
+      let(:scss) { '$variable: 1;' }
 
       it { should_not report_lint }
     end
 
-    context 'when a name contains a double underscore and double hyphen' do
-      let(:scss) { '@extend %block--thing__word;' }
+    context 'when a name contains all lowercase letters and underscores' do
+      let(:scss) { '$my_variable: 1;' }
 
       it { should_not report_lint }
     end
-  end
 
-  context 'when a regexp convention is specified' do
-    let(:linter_config) { { 'convention' => '^[a-v_-]+$' } }
+    context 'when a name contains all lowercase letters and hyphens' do
+      let(:scss) { '$my-variable: 1;' }
 
-    context 'when a name contains no underscores or hyphens' do
-      let(:scss) { '@extend %block;' }
-
-      it { should_not report_lint }
+      it { should report_lint }
     end
 
-    context 'when a name contains a single underscore' do
-      let(:scss) { '@extend %block_thing;' }
+    context 'when a name contains any uppercase letters' do
+      let(:scss) { '$myVariable: 1;' }
 
-      it { should_not report_lint }
+      it { should report_lint }
+    end
+  end
+
+  context 'when type-specific convention is defined with a global convention' do
+    let(:linter_config) do
+      { 'convention' => 'camel_case', 'variable_convention' => 'snake_case' }
     end
 
-    context 'when a name contains a single hyphen' do
-      let(:scss) { '@extend %block-thing;' }
+    context 'when specific type satisfies the type-specific convention' do
+      let(:scss) { '$my_variable: 1;' }
 
       it { should_not report_lint }
     end
 
-    context 'when a name contains a uppercase character' do
-      let(:scss) { '@extend Block-thing;' }
+    context 'when specific type does not satisfy the type-specific convention' do
+      let(:scss) { '$myVariable: 1;' }
 
       it { should report_lint }
     end
 
-    context 'when a name contains an unallowed character' do
-      let(:scss) { '@extend zoo;' }
+    context 'when other type satisfies the global convention' do
+      let(:scss) { '@function myFunction() {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when other type does not satisfy the global convention' do
+      let(:scss) { '@function my_function() {}' }
 
       it { should report_lint }
     end

data/spec/scss_lint/linter/selector_format_spec.rb

@@ -454,8 +454,8 @@ describe SCSSLint::Linter::SelectorFormat do
     end
   end
 
-  context 'when the BEM convention is specified' do
-    let(:linter_config) { { 'convention' => 'BEM' } }
+  context 'when the strict_BEM convention is specified' do
+    let(:linter_config) { { 'convention' => 'strict_BEM' } }
 
     context 'when a name contains no underscores or hyphens' do
       let(:scss) { '.block {}' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -256,14 +256,18 @@ signing_key:
 specification_version: 4
 summary: SCSS lint tool
 test_files:
+- spec/scss_lint/cli_spec.rb
 - spec/scss_lint/config_spec.rb
 - spec/scss_lint/engine_spec.rb
+- spec/scss_lint/file_finder_spec.rb
 - spec/scss_lint/linter/bang_format_spec.rb
 - spec/scss_lint/linter/border_zero_spec.rb
 - spec/scss_lint/linter/color_keyword_spec.rb
+- spec/scss_lint/linter/color_variable_spec.rb
 - spec/scss_lint/linter/comment_spec.rb
 - spec/scss_lint/linter/compass/property_with_mixin_spec.rb
 - spec/scss_lint/linter/debug_statement_spec.rb
+- spec/scss_lint/linter/declaration_order_spec.rb
 - spec/scss_lint/linter/duplicate_property_spec.rb
 - spec/scss_lint/linter/else_placement_spec.rb
 - spec/scss_lint/linter/empty_line_between_blocks_spec.rb
@@ -284,6 +288,7 @@ test_files:
 - spec/scss_lint/linter/property_count_spec.rb
 - spec/scss_lint/linter/property_sort_order_spec.rb
 - spec/scss_lint/linter/property_spelling_spec.rb
+- spec/scss_lint/linter/property_units_spec.rb
 - spec/scss_lint/linter/qualifying_element_spec.rb
 - spec/scss_lint/linter/selector_depth_spec.rb
 - spec/scss_lint/linter/selector_format_spec.rb
@@ -305,9 +310,6 @@ test_files:
 - spec/scss_lint/linter/variable_for_property_spec.rb
 - spec/scss_lint/linter/vendor_prefix_spec.rb
 - spec/scss_lint/linter/zero_unit_spec.rb
-- spec/scss_lint/linter/color_variable_spec.rb
-- spec/scss_lint/linter/declaration_order_spec.rb
-- spec/scss_lint/linter/property_units_spec.rb
 - spec/scss_lint/linter_registry_spec.rb
 - spec/scss_lint/linter_spec.rb
 - spec/scss_lint/location_spec.rb
@@ -319,10 +321,8 @@ test_files:
 - spec/scss_lint/reporter/json_reporter_spec.rb
 - spec/scss_lint/reporter/xml_reporter_spec.rb
 - spec/scss_lint/reporter_spec.rb
-- spec/scss_lint/selector_visitor_spec.rb
-- spec/scss_lint/file_finder_spec.rb
 - spec/scss_lint/runner_spec.rb
-- spec/scss_lint/cli_spec.rb
+- spec/scss_lint/selector_visitor_spec.rb
 - spec/spec_helper.rb
 - spec/support/isolated_environment.rb
 - spec/support/matchers/report_lint.rb