itcss_cli 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28404c509132024ac6b5bfc67ea6f54bc5dc38d0
-  data.tar.gz: 476791a7913401775c8b13461eaf2234f07b2e2e
+  metadata.gz: 37df35d02e52c9edcb047e374dfcd9b27bafd851
+  data.tar.gz: c642c24d3a2144e6afda5c73ffbfeae86ad6a0ae
 SHA512:
-  metadata.gz: 0fef028465b64e0ae78ee324270e08feea0a6f27582a7295044618113fe9be83b008968e7831bd73a9d377af4e912327367707546646a6a78978e432fccaee87
-  data.tar.gz: 894d156bb6db774bc3908247d2e5784eda0a159d1ec89b7a215474377b297374e1f9d25dd29fb5f528043ba08924484bca8f37db5d9b3a80d1e1ee8530b19ea3
+  metadata.gz: 473cc79e3a7b63131248d03b7741fbe6daedc776a93e31ba5f8f81d2346610a9692d8da0c0e9120f8af936cbab210106a14e05c8674c9c8a9f1924e7be33b22f
+  data.tar.gz: 653898991ae995203e6628a3761269dbf1bb109dbc4cbf2d8162dfaa2a060ad9dbf3e6b2a2a8bb739ed3c33e2b78a4b25845ed86db58356eb1e296d69a0437b4

data/README.md

@@ -1,9 +1,3 @@
-# ItcssCli
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/itcss_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +16,102 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you'll need to set up ITCSS by running:
+
+    $ itcss init
+    
+Now go to `itcss.yml` and define define where Itcss_cli should create the ITCSS structure and the name of it's base file:
+
+```yml
+# Provide the root folder where the ITCSS file structure should be built.
+stylesheets_directory: 'source/assets/stylesheets'
+
+# Provide your base sass file (all ITCSS modules will be imported in it).
+stylesheets_import_file: 'application.css'
+```
+
+Go ahead and grow your ITCSS structure:
+```{r, engine='bash'}
+$ itcss new component modals
+create source/stylesheets/components/_components.modals.sass
+update source/stylesheets/application.css.sass
+
+$ itcss new trumps helpers
+create source/stylesheets/trumps/_trumps.helpers.sass
+update source/stylesheets/application.css.sass
+```
+
+## Example
+Creating a full ITCSS structure:
+
+```{r, engine='bash'}
+$ itcss init
+create itcss.yml
+Well done! Please do your own configurations in itcss.yml.
+
+[[[ Open the `itcss.yml` file and edit it. ]]]
+
+$ itcss install example
+create source/stylesheets/settings/_settings.example.sass
+create source/stylesheets/tools/_tools.example.sass
+create source/stylesheets/generic/_generic.example.sass
+create source/stylesheets/base/_base.example.sass
+create source/stylesheets/objects/_objects.example.sass
+create source/stylesheets/components/_components.example.sass
+create source/stylesheets/trumps/_trumps.example.sass
+update source/stylesheets/application.css.sass
+```
+
+If you open the ITCSS's base file now, you'll see that all ITCSS modules are automatically imported into it:
+```sass
+@charset "utf-8"
+
+// ========================================
+//   application.css.sass
+// ========================================
+
+
+// [0] Requirements --- Vendor libraries
+// [1] Settings ------- Sass vars, etc.
+// [2] Tools ---------- Functions and mixins.
+// [3] Generic -------- Generic, high-level styling, like resets, etc.
+// [4] Base ----------- Unclasses HTML elements (e.g. `h2`, `ul`).
+// [5] Objects -------- Objects and abstractions.
+// [6] Components ----- Your designed UI elements (inuitcss includes none of these).
+// [7] Trumps --------- Overrides and helper classes.
+
+// ↓ ITCSS_CLI FILE IMPORTING ↓
+
+// [0] Settings
+@import "settings/_settings.example.sass"
+
+
+// [1] Tools
+@import "tools/_tools.example.sass"
+
+
+// [2] Generic
+@import "generic/_generic.example.sass"
+
+
+// [3] Base
+@import "base/_base.example.sass"
+
+
+// [4] Objects
+@import "objects/_objects.example.sass"
+
+
+// [5] Components
+@import "components/_components.example.sass"
+
+
+// [6] Trumps
+@import "trumps/_trumps.example.sass"
+
+
+// ↑ ITCSS_CLI FILE IMPORTING ↑
+```
 
 ## Development
 

data/lib/itcss_cli/version.rb

@@ -1,3 +1,3 @@
 module ItcssCli
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

data/lib/itcss_cli.rb

@@ -23,6 +23,15 @@ module ItcssCli
       "trumps" => "Overrides and helper classes."
     }
 
+    ITCSS_COMMANDS = [
+      "itcss init                       | Initiates itcss_cli configuration with a itcss.yml file. [start here]",
+      "itcss install example            | Creates an example of ITCSS structure in path specified in itcss.yml.",
+      "itcss new [module] [filename]    | Creates a new ITCSS module and automatically import it into imports file.",
+      "itcss update                     | Updates the imports file using the files inside ITCSS structure.",
+      "itcss help                       | Shows all available itcss commands and it's functions.",
+      "itcss version                    | Shows itcss_cli gem version installed. [short-cut alias: '-v', 'v']"
+    ]
+
     if File.exist?(ITCSS_CONFIG_FILE)
       ITCSS_CONFIG = YAML.load_file(ITCSS_CONFIG_FILE)
       ITCSS_CONFIG['stylesheets_directory'].nil? ? ITCSS_DIR = nil : ITCSS_DIR = ITCSS_CONFIG['stylesheets_directory']
@@ -67,6 +76,16 @@ module ItcssCli
           puts "'#{ARGV[1]}' is not an ITCSS module. Try settings, tools, generic, base, objects, components or trumps.".red
           abort
         end
+
+
+      # $ itcss help
+      elsif ARGV[0] == 'help'
+        itcss_help
+
+
+      # $ itcss version
+      elsif ARGV[0] == 'version' || ARGV[0] == '-v' || ARGV[0] == 'v'
+        itcss_version
       end
 
       # $ itcss update
@@ -150,5 +169,14 @@ module ItcssCli
       puts "update #{file_path}".blue
     end
 
+    def itcss_help
+      puts "itcss_cli available commmands:".yellow
+      puts ITCSS_COMMANDS.map{|s| s.prepend("  ")}
+    end
+
+    def itcss_version
+      puts VERSION
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itcss_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Kande Bonfim