color_json 0.0.1.1 → 0.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef2fce1d5de8cfe68deb6aea95d3f6a8c8b31411
-  data.tar.gz: 55e42a683ec8fd2c36e8f08c2e34add6966713c2
+  metadata.gz: cde06551ff3493a9f08900a7dd30ea03e9de983d
+  data.tar.gz: 2d1dd04d23f777105294900ca8537fc08fc54108
 SHA512:
-  metadata.gz: 04ca1f3e3fb3c0cbc67a78018390ab6eb42577b87e1f8f9b8a02859b86a9cfc79d6a92fa3e86d2b12eff8834fc35ad150a6e455da204b1015cdf1b7ef926aba7
-  data.tar.gz: 7e77ad247e6a3d0edd5d74e9f93f48f44f921dbaf1ed34e507430c8ba327a609203a0dbe3a6393d562be8561dedcb1f3d07cd20ea80fea8a3803a1e9717ab36a
+  metadata.gz: fd790a942ca369e715e938d7c2c1fedb0b34936ac4efcf7a5508cf2a65dfab0278b167f27594b89660b8f26d89a83a6c905735a88ba60e93ef4be95552c40c85
+  data.tar.gz: 82fc08698643062a10b4a6959cb59126423095fed264eee2856b296a7316b48cd2f9bdbbfcaf57ff8ad03f0fb5745e60bdeb730254b658b53489b07fc14d9115

data/README.md

@@ -1,6 +1,6 @@
 # ColorJson
 
-Easy way to show your sass/scss/less color list.
+Easy way to show your `sass/scss/less color` list.
 
 ## Installation
 
@@ -20,12 +20,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    color_json build <filename>
 
-## Contributing
+then you would got your `color.json` file!
 
-1. Fork it ( https://github.com/[my-github-username]/color_json/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+### Example
+
+#### Basic usage
+`no_group.scss`:
+
+```scss
+$aqua:  #7FDBFF;
+$blue:  #0074D9;
+$navy:  #001F3F;
+$teal:  #39CCCC;
+```
+
+it would generate:
+
+`color.json`:
+
+```json    
+"color": {
+  "$aqua": "  #7FDBFF;",
+  "$blue": "  #0074D9;",
+  "$navy": "  #001F3F;",
+  "$teal": "  #39CCCC;"
+}
+```
+#### Group usage
+
+You can use `//**` to label your color usage. 
+
+`group.scss`:
+
+```scss
+//** main color
+$aqua:  #7FDBFF;
+$blue:  #0074D9;
+
+//** other
+$yellow:  #FFDC00;
+$orange:  #FF851B;
+```
+
+it would generate:
+
+`color.json`:
+```json
+"color": {
+  "main color": {
+    "$aqua": "  #7FDBFF;",
+    "$blue": "  #0074D9;"
+  },
+  "other": {
+    "$yellow": "  #FFDC00;",
+    "$orange": "  #FF851B;"
+  }
+}
+```
+
+## What the color.json can do?
+
+`color.json` can combine with [canner](github.com/canner/canner) and help you show your color list very quickly.
+
+
+## Issue
+
+This gem has many needs for imporvement.
+
+Feel free to fork it and pull request.
+
+## License
+
+[@ctxhou](github.com/ctxhou) MIT

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
 
+
+desc "test build"
+task :bu do
+    file = ARGV.last
+    bundle exec "bin/color_json build " + file
+end

data/example/example.scss

@@ -0,0 +1,7 @@
+//** main color
+$aqua:  #7FDBFF;
+$blue:  #0074D9;
+
+//** other
+$yellow:  #FFDC00;
+$orange:  #FF851B;

data/example/no_group.scss

@@ -0,0 +1,7 @@
+$aqua:  #7FDBFF;
+$blue:  #0074D9;
+$navy:  #001F3F;
+$teal:  #39CCCC;
+$green: #2ECC40;
+$olive: #3D9970;
+$lime:  #01FF70;

data/lib/color_json.rb

@@ -31,7 +31,7 @@ module ColorJson
         end
 
         File.open('color.json', "w") do |f|
-            f << color_json.to_json
+            f << JSON.pretty_generate(color_json)
         end
     end
 end

data/lib/color_json/cli/application.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require "color_json"
+
+module Cli
+    class Application < Thor
+        default_task :help
+        desc 'build FILE', 'Input your file and generate the color json file.'
+        def build(file)
+            ColorJson.build(file)
+        end
+    end
+end

data/lib/color_json/version.rb

@@ -1,3 +1,3 @@
 module ColorJson
-  VERSION = "0.0.1.1"
+  VERSION = "0.0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: color_json
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 0.0.1.2
 platform: ruby
 authors:
 - ctxhou
@@ -67,7 +67,10 @@ files:
 - Rakefile
 - bin/color_json
 - color_json.gemspec
+- example/example.scss
+- example/no_group.scss
 - lib/color_json.rb
+- lib/color_json/cli/application.rb
 - lib/color_json/version.rb
 homepage: ''
 licenses: