From 9351bb30725c639e2389d29b2aed5ff745118dd7 Mon Sep 17 00:00:00 2001 From: Kaelig Date: Fri, 4 Mar 2016 15:13:37 -0800 Subject: [PATCH] Add custom linter to prevent breaking the scoped build --- .scss-lint.yml | 5 ++ .../disallow_last_parent_reference.rb | 59 +++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 .scss-linters/disallow_last_parent_reference.rb diff --git a/.scss-lint.yml b/.scss-lint.yml index ba9a92bd95..4949ca31f8 100644 --- a/.scss-lint.yml +++ b/.scss-lint.yml @@ -1,6 +1,8 @@ # Documentation: # https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/linter/README.md +plugin_directories: ['.scss-linters'] + scss_files: '{ui,site/assets/styles}/**/*.scss' exclude: - node_modules @@ -126,3 +128,6 @@ linters: enabled: true ZeroUnit: enabled: true + DisallowLastParentSelector: + enabled: true + severity: error diff --git a/.scss-linters/disallow_last_parent_reference.rb b/.scss-linters/disallow_last_parent_reference.rb new file mode 100644 index 0000000000..c96ebc2294 --- /dev/null +++ b/.scss-linters/disallow_last_parent_reference.rb @@ -0,0 +1,59 @@ +# Copyright (c) 2015, salesforce.com, inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +# Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +# Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +# Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +module SCSSLint + # Prevent this syntax: + # foo { + # bar & { + # ... + # } + # } + class Linter::DisallowLastParentSelector < Linter + include LinterRegistry + MESSAGE = 'Unsupported parent (&) selector (will break the scoped build)'.freeze + + def visit_comma_sequence(comma_sequence) + @multiple_sequences = comma_sequence.members.size > 1 + end + + def visit_sequence(sequence) + return unless sequence_ends_with_parent?(sequence.members.last) + + # Allow concatentation, e.g. + # element { + # &.foo {} + # } + return if sequence.members.last.members.size > 1 + + # Allow isolated parent + return if isolated_parent?(sequence) + + # Special case: allow an isolated parent to appear if it is part of a + # comma sequence of more than one sequence, as this could be used to DRY + # up code. + return if @multiple_sequences && isolated_parent?(sequence) + + add_lint(sequence.members.last.line, MESSAGE) + end + + private + + def isolated_parent?(sequence) + sequence.members.size == 1 && + sequence_ends_with_parent?(sequence.members.last) + end + + def sequence_ends_with_parent?(simple_sequence) + return unless simple_sequence.is_a?(Sass::Selector::SimpleSequence) + last = simple_sequence.members.last + last.is_a?(Sass::Selector::Parent) && + last.suffix.nil? # Ignore concatenated selectors, like `&-something` + end + end +end