Installation
Add this line to your application's Gemfile:
gem 'itcss_cli'And then execute:
$ bundle
Or install it yourself as:
$ gem install itcss_cli
Usage
First, you'll need to set up ITCSS by running:
$ itcss init
Now go to itcss.yml and do your itcss_cli config:
# Root folder where the ITCSS file structure should be builded.
stylesheets_directory: source/stylesheets
# Base sass file (all ITCSS modules will be imported in it).
stylesheets_import_file: application
# Uncomment to enable inuit modules importing. [ bower or npm ]
# package_manager: bower
# inuit_modules:
# - tools.functions
# - settings.defaults
# - base.pageGo ahead and grow your ITCSS structure:
$ itcss new component modals
create source/stylesheets/components/_components.modals.sass
update source/stylesheets/application.sass
$ itcss new trumps helpers
create source/stylesheets/trumps/_trumps.helpers.sass
update source/stylesheets/application.sass
Inuitcss Commands
You can install and automatically import inuit modules via cli:
$ itcss inuit new settings.defaults
using bower to install inuit 'settings.defaults' dependency...
bower inuit-defaults#~0.2.3 install inuit-defaults#0.2.3
inuit-defaults#0.2.3 bower_components/inuit-defaults
update itcss.yml. [added settings.defaults]
update source/stylesheets/application.sass
Result at application.sass:
...
// [1] Settings
@import "inuit-defaults/settings.defaults"
...Creating a full ITCSS structure
$ 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:
@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 ↑Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/itcss_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Development
$ bundle
$ rvm gemset create itcsscli && rvm gemset use itcsscli
To compile sass:
$ sass --watch assets/itcss.sass:assets/itcss.css --style compressed --sourcemap=none
License
The gem is available as open source under the terms of the MIT License.