scss_beautifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ce70dc26b3aba0b8f6c3d9ad761a86cadc3b424
+  data.tar.gz: 7a31fde608c0e532a9eb00f92d16014fc41aff8d
+SHA512:
+  metadata.gz: 0cbf7a4fea907cf8a73c06bdec3eaf2bcf815cd95ad2b203811769410e29ec1ebfbd3371216cc95f1b17e62a4e4180cb46f28b7a885783cf2afe8ca0d91bb76f
+  data.tar.gz: 764cb602dee01882d61aacddaed12f7cca74afe2126f1e5e7fe33a0ff60479a8857faf0fb919e4bc2fef1683fc16fa77c2b43394c02ef80eb85464635daee724

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ivan.tse1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scss_beautifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    scss_beautifier (0.1.0)
+      sass (~> 3.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    sass (3.4.22)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  scss_beautifier!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ivan Tse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# SCSSBeautifier
+
+Beautify your SCSS code so that the formatting is consistent and adherent to your style guide.
+
+## Installation
+
+Install it as a gem:
+
+    $ gem install scss_beautifier
+
+## Usage
+
+`scss-beautify the_scss_file.scss`
+
+This will print out the formatted SCSS code.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paperlesspost/scss_beautifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scss_beautifier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/default_config.yml

@@ -0,0 +1,49 @@
+formatters:
+
+  border_zero:
+    enabled: true
+
+  comment:
+    enabled: true
+
+  color:
+    enabled: true
+
+  debug:
+    enabled: true
+
+  empty_rule:
+    enabled: true
+
+  selector:
+    enabled: true
+
+  declaration_order:
+    enabled: true
+
+  # else_placement:
+  #   enabled: true
+
+  leading_zero:
+    enabled: true
+
+  name_format:
+    enabled: true
+
+  property_sort_order:
+    enabled: true
+
+  pseudo_element:
+    enabled: true
+
+  qualifying_element:
+    enabled: true
+
+  shorthand:
+    enabled: true
+
+  string_quotes:
+    enabled: true
+
+  trailing_zero:
+    enabled: true

data/data/pseudo_elements.txt

@@ -0,0 +1,97 @@
+-moz-anonymous-block
+-moz-anonymous-positioned-block
+-moz-canvas
+-moz-cell-content
+-moz-focus-inner
+-moz-focus-outer
+-moz-inline-table
+-moz-page
+-moz-page-sequence
+-moz-pagebreak
+-moz-pagecontent
+-moz-placeholder
+-moz-progress-bar
+-moz-progress-bar
+-moz-range-thumb
+-moz-range-track
+-moz-scrolled-canvas
+-moz-scrolled-content
+-moz-scrolled-page-sequence
+-moz-selection
+-moz-svg-foreign-content
+-moz-table
+-moz-table-cell
+-moz-table-column
+-moz-table-column-group
+-moz-table-outer
+-moz-table-row
+-moz-table-row-group
+-moz-viewport
+-moz-viewport-scroll
+-moz-xul-anonymous-block
+-ms-browse
+-ms-check
+-ms-clear
+-ms-expand
+-ms-expand
+-ms-fill
+-ms-fill-lower
+-ms-fill-upper
+-ms-reveal
+-ms-thumb
+-ms-ticks-after
+-ms-ticks-before
+-ms-tooltip
+-ms-track
+-ms-value
+-webkit-calendar-picker-indicator
+-webkit-color-swatch
+-webkit-color-swatch-wrapper
+-webkit-datetime-edit
+-webkit-datetime-edit-day-field
+-webkit-datetime-edit-fields-wrapper
+-webkit-datetime-edit-month-field
+-webkit-datetime-edit-text
+-webkit-datetime-edit-year-field
+-webkit-file-upload-button
+-webkit-full-page-media
+-webkit-inner-spin-button
+-webkit-input-placeholder
+-webkit-keygen-select
+-webkit-meter-bar
+-webkit-meter-even-less-good-value
+-webkit-meter-optimum-value
+-webkit-meter-suboptimum-value
+-webkit-outer-spin-button
+-webkit-progress-bar
+-webkit-progress-inner-element
+-webkit-progress-value
+-webkit-resizer
+-webkit-scrollbar
+-webkit-scrollbar-button
+-webkit-scrollbar-corner
+-webkit-scrollbar-thumb
+-webkit-scrollbar-track
+-webkit-scrollbar-track-piece
+-webkit-search-cancel-button
+-webkit-search-decoration
+-webkit-search-results-button
+-webkit-search-results-decoration
+-webkit-slider-runnable-track
+-webkit-slider-thumb
+-webkit-textfield-decoration-container
+-webkit-validation-bubble
+-webkit-validation-bubble-arrow
+-webkit-validation-bubble-arrow-clipper
+-webkit-validation-bubble-heading
+-webkit-validation-bubble-message
+-webkit-validation-bubble-text-block
+after
+backdrop
+before
+content
+first-letter
+first-line
+placeholder
+selection
+shadow

data/exe/scss-beautify

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+require "scss_beautifier"
+
+SCSSBeautifier::CLI.new.run(ARGV)

data/lib/scss_beautifier.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+$:.unshift "/Users/joenatalzia/Sites/tools/sass/lib"
+
+module SCSSBeautifier
+  module Formatters
+  end
+end
+
+require "sass"
+
+require "scss_beautifier/version"
+require "scss_beautifier/cli"
+require "scss_beautifier/config"
+
+# Our custom SCSS to SCSS converter
+require "scss_beautifier/convert"
+
+# Formatters
+require "scss_beautifier/formatters/bang_format"
+require "scss_beautifier/formatters/border_zero"
+require "scss_beautifier/formatters/color"
+require "scss_beautifier/formatters/comment"
+require "scss_beautifier/formatters/debug"
+require "scss_beautifier/formatters/declaration_order"
+require "scss_beautifier/formatters/empty_rule"
+require "scss_beautifier/formatters/leading_zero"
+require "scss_beautifier/formatters/name_format"
+require "scss_beautifier/formatters/property_sort_order"
+require "scss_beautifier/formatters/pseudo_element"
+require "scss_beautifier/formatters/qualifying_element"
+require "scss_beautifier/formatters/selector"
+require "scss_beautifier/formatters/shorthand"
+require "scss_beautifier/formatters/string_quotes"
+require "scss_beautifier/formatters/trailing_zero"

data/lib/scss_beautifier/cli.rb

@@ -0,0 +1,20 @@
+module SCSSBeautifier
+  class CLI
+    DEFAULT = File.realpath(File.join(File.dirname(__FILE__), "..", "..", "data", "default_config.yml")).freeze
+    # Takes an array of arguments
+    # Returns exit code
+    def run(args)
+      contents = File.read(ARGV.first)
+      engine = Sass::Engine.new(contents, cache: false, syntax: :scss)
+
+      tree = engine.to_tree
+      Config.new(DEFAULT).formatters.each do |formatter|
+        formatter.visit(tree)
+      end
+
+      puts SCSSBeautifier::Convert.visit(tree, {}, :scss)
+
+    end
+
+  end
+end

data/lib/scss_beautifier/config.rb

@@ -0,0 +1,21 @@
+require "yaml"
+
+module SCSSBeautifier
+  class Config
+
+    def initialize(config_location)
+      @config = parse_config(config_location)
+    end
+
+    def parse_config(config_location)
+      YAML.load(File.read(config_location))
+    end
+
+    def formatters
+      enabled_formatters = @config["formatters"].select {|_, formatter| formatter["enabled"] }.keys
+      enabled_formatters.map do |formatter|
+        SCSSBeautifier::Formatters.const_get(formatter.split("_").map(&:capitalize).join)
+      end
+    end
+  end
+end

data/lib/scss_beautifier/convert.rb

@@ -0,0 +1,31 @@
+class SCSSBeautifier::Convert < Sass::Tree::Visitors::Convert
+  def visit_if(node, &block)
+    if true
+      visit_if_no_newline(node, &block)
+    else
+      super(node)
+    end
+  end
+  # ElsePlacement
+  def visit_if_no_newline(node)
+    name =
+      if !@is_else
+        "if"
+      elsif node.expr
+        "else if"
+      else
+        "else"
+      end
+    @is_else = false
+    str = "#{tab_str}@#{name}"
+    str << " #{node.expr.to_sass(@options)}" if node.expr
+    str << yield
+    str.rstrip! if node.else
+    @is_else = true
+    str << ' ' + visit(node.else).lstrip! if node.else
+    str
+  ensure
+    @is_else = false
+  end
+
+end