flint-gs 2.0.6 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ec4363f44d3c5474f6d3fdc697bf91195bc96b1
-  data.tar.gz: a0c558f75bcd47c2bfde2ba6e925165bd9bb5c33
+  metadata.gz: dad60492a22ed4c6e68d63a1259ac3f202d051db
+  data.tar.gz: ea0753745e39f131ca86ea433cc04b0ed698e752
 SHA512:
-  metadata.gz: 49804977514417dcbb95397f3120c6ede20b077a95b1da7490182098754fcb05c1577ad79cdb84291e06ddf17595650bf036451cd28d6be976051d153a9a1e99
-  data.tar.gz: b555be8276ad1d2dd136143a2e273a619b9e14f3ed4cf3e282573ceaedd6cd9d31ff95b125a299040fd3b40c6289b8a8fbe8424d83e2c95217e9392182cd866f
+  metadata.gz: 8673ea60dcf096602b1ead2c718ad6c042c2430867c6ed42620f844919f31ec10422f48421daaf46dd5a27b051775bb18d15e28840b3833abd04bf1d7eb54575
+  data.tar.gz: f2ad842af93ad65c1ab72c0b706a3d7461b1d7eefc9386253a8dd424ed1ea8f7ceef8480657ce2c0b07e94987830879f8efc237695fa3092ab3ea3232307d7b2

data/README.md

@@ -43,6 +43,8 @@ scss --require ./lib/flint.rb example.scss > example.css
 
 Documentation is located [here](http://flint.gs/docs).
 
+_Tip: For simple projects, disable `instance-maps`, as it is has a large overhead and will increase your compile times._
+
 ## Syntax support
 
 As of `1.6.0`, you can add syntax support for your preferred syntax. I built the system for BEM, but it should be easily extendable to
@@ -50,17 +52,17 @@ support your preferred syntax. Simply create a function which parses a string of
 function parses the selector string (for example, `.block__element__element`) like so,
 
 ```scss
-/**
- * Parser to support BEM syntax
- *
- * @access private
- *
- * @param {List} $selectors - string of selectors to parse
- *
- * @return {List} - parsed list of selectors according to syntax
- *
- * @group Internal Functions
- */
+///
+/// Parser to support BEM syntax
+///
+/// @access private
+///
+/// @param {List} $selectors - string of selectors to parse
+///
+/// @return {List} - parsed list of selectors according to syntax
+///
+/// @group Internal Functions
+///
 @function flint-support-syntax-bem($selectors) {
     // Clean up selector, remove double underscores for spaces
     //  add pseudo character to differentiate selectors

data/lib/flint/version.rb

@@ -1,3 +1,3 @@
 module Flint
-    VERSION = "2.0.6"
+    VERSION = "2.0.8"
 end

data/stylesheets/_flint.scss

@@ -1,6 +1,6 @@
-/*
- * Flint
- */
+//
+// Flint
+//
 @import "flint/config/config";
 @import "flint/functions/functions";
 @import "flint/globals/globals";

data/stylesheets/flint/config/_config.scss

@@ -1,27 +1,27 @@
-/**
- * Configuration map
- *
- * @type Map
- *
- * @prop {Map}    breakpoints                  - map of breakpoints, follow DSC order
- * @prop {Map}    breakpoints.alias            - named map of breakpoint settings
- * @prop {Number} breakpoints.alias.columns    - column count for breakpoint
- * @prop {Number} breakpoints.alias.breakpoint - breakpoint value for breakpoint
- *
- * @prop {Map}    settings                     - map of settings for grid
- * @prop {String} settings.default             - alias of breakpoint to be grid default
- * @prop {String} settings.grid                - type of grid
- * @prop {Number} settings.gutter              - value for gutter
- * @prop {String} settings.float-direction     - direction of float
- * @prop {Bool}   settings.max-width           - maximum width value
- * @prop {Bool}   settings.center-container    - center containers
- * @prop {Bool}   settings.border-box-sizing   - use `box-sizing: border-box`
- * @prop {Bool}   settings.instance-maps       - use instance maps for added features
- * @prop {Bool}   settings.support-syntax      - support syntax within instance functions
- * @prop {Bool}   settings.debug-mode          - enable debug mode
- *
- * @group Configuration
- */
+///
+/// Configuration map
+///
+/// @type Map
+///
+/// @prop {Map}    breakpoints                  - map of breakpoints, follow DSC order
+/// @prop {Map}    breakpoints.alias            - named map of breakpoint settings
+/// @prop {Number} breakpoints.alias.columns    - column count for breakpoint
+/// @prop {Number} breakpoints.alias.breakpoint - breakpoint value for breakpoint
+///
+/// @prop {Map}    settings                     - map of settings for grid
+/// @prop {String} settings.default             - alias of breakpoint to be grid default
+/// @prop {String} settings.grid                - type of grid
+/// @prop {Number} settings.gutter              - value for gutter
+/// @prop {String} settings.float-direction     - direction of float
+/// @prop {Bool}   settings.max-width           - maximum width value
+/// @prop {Bool}   settings.center-container    - center containers
+/// @prop {Bool}   settings.border-box-sizing   - use `box-sizing: border-box`
+/// @prop {Bool}   settings.instance-maps       - use instance maps for added features
+/// @prop {Bool}   settings.support-syntax      - support syntax within instance functions
+/// @prop {Bool}   settings.debug-mode          - enable debug mode
+///
+/// @group Configuration
+///
 $flint: (
     "breakpoints": (
         "desktop": (

data/stylesheets/flint/functions/_functions.scss

@@ -1,11 +1,11 @@
-/*
- * Helpers
- */
+//
+// Helpers
+//
 @import "helpers/helpers";
 
-/*
- * Functions
- */
+//
+// Functions
+//
 @import "lib/exists";
 
 // Getters
@@ -38,9 +38,9 @@
 @import "lib/replace-substring";
 @import "lib/string-to-list";
 
-/*
- * Support syntax
- */
+//
+// Support syntax
+//
 @import "lib/use-syntax";
 @import "lib/support-syntax";
 

data/stylesheets/flint/functions/helpers/_helpers.scss

@@ -1,114 +1,114 @@
-/**
- * @group Internal Helper Functions
- **/
-
-/**
- * Returns truthiness of a value
- *
- * @access private
- *
- * @param {*} $value
- *
- * @return {Bool}
- */
+////
+/// @group Internal Helper Functions
+////
+
+///
+/// Returns truthiness of a value
+///
+/// @access private
+///
+/// @param {*} $value
+///
+/// @return {Bool}
+///
 @function flint-is-true($value) {
 	@return if($value == null, false, $value and $value != null and $value != "" and $value != ());
 }
 
-/**
- * Checks if item is map
- *
- * @access private
- *
- * @param {Map} $n
- *
- * @return {Bool}
- */
+///
+/// Checks if item is map
+///
+/// @access private
+///
+/// @param {Map} $n
+///
+/// @return {Bool}
+///
 @function flint-is-map($n) {
 	@return type-of($n) == "map";
 }
 
-/**
- * Checks if item is list
- *
- * @access private
- *
- * @param {List} $n
- *
- * @return {Bool}
- */
+///
+/// Checks if item is list
+///
+/// @access private
+///
+/// @param {List} $n
+///
+/// @return {Bool}
+///
 @function flint-is-list($n) {
 	@return type-of($n) == "list";
 }
 
-/**
- * Checks if item is number
- *
- * @access private
- *
- * @param {Number} $n
- *
- * @return {Bool}
- */
+///
+/// Checks if item is number
+///
+/// @access private
+///
+/// @param {Number} $n
+///
+/// @return {Bool}
+///
 @function flint-is-number($n) {
 	@return type-of($n) == "number";
 }
 
-/**
- * Checks if item is string
- *
- * @access private
- *
- * @param {String} $n
- *
- * @return {Bool}
- */
+///
+/// Checks if item is string
+///
+/// @access private
+///
+/// @param {String} $n
+///
+/// @return {Bool}
+///
 @function flint-is-string($n) {
 	@return type-of($n) == "string";
 }
 
-/**
- * Checks if item is not string
- *
- * @access private
- *
- * @param {String} $n
- *
- * @return {Bool}
- */
+///
+/// Checks if item is not string
+///
+/// @access private
+///
+/// @param {String} $n
+///
+/// @return {Bool}
+///
 @function flint-is-not-string($n) {
 	@return type-of($n) != "string";
 }
 
-/**
- * Get gutter value from config map
- *
- * @access private
- *
- * @return {Number}
- */
+///
+/// Get gutter value from config map
+///
+/// @access private
+///
+/// @return {Number}
+///
 @function flint-get-gutter() {
 	@return flint-get-value("settings", "gutter");
 }
 
-/**
- * Gets list of each breakpoint's key
- *
- * @access private
- *
- * @return {List}
- */
+///
+/// Gets list of each breakpoint's key
+///
+/// @access private
+///
+/// @return {List}
+///
 @function flint-get-all-keys() {
 	@return map-keys(flint-get-value("breakpoints"));
 }
 
-/**
- * Gets list of all breakpoints
- *
- * @access private
- *
- * @return {List}
- */
+///
+/// Gets list of all breakpoints
+///
+/// @access private
+///
+/// @return {List}
+///
 @function flint-get-all-breakpoints() {
 	$all-keys: flint-get-all-keys();
 	$all-breakpoints: ();
@@ -120,52 +120,52 @@
 	@return $all-breakpoints;
 }
 
-/**
- * Checks if passed $key is the highest breakpoint
- *
- * @access private
- *
- * @param {String} $key - alias of breakpoint
- *
- * @return {Bool}
- */
+///
+/// Checks if passed $key is the highest breakpoint
+///
+/// @access private
+///
+/// @param {String} $key - alias of breakpoint
+///
+/// @return {Bool}
+///
 @function flint-is-highest-breakpoint($key) {
 	@return flint-get-value("breakpoints", $key, "breakpoint") == max(flint-get-all-breakpoints()...);
 }
 
-/**
- * Checks if passed $key is the lowest breakpoint
- *
- * @access private
- *
- * @param {String} $key - alias of breakpoint
- *
- * @return {Bool}
- */
+///
+/// Checks if passed $key is the lowest breakpoint
+///
+/// @access private
+///
+/// @param {String} $key - alias of breakpoint
+///
+/// @return {Bool}
+///
 @function flint-is-lowest-breakpoint($key) {
 	@return flint-get-value("breakpoints", $key, "breakpoint") == min(flint-get-all-breakpoints()...);
 }
 
-/**
- * Checks if $key is grid default
- *
- * @access private
- *
- * @param {String} $key - alias of breakpoint
- *
- * @return {Bool}
- */
+///
+/// Checks if $key is grid default
+///
+/// @access private
+///
+/// @param {String} $key - alias of breakpoint
+///
+/// @return {Bool}
+///
 @function flint-is-default($key) {
 	@return $key == flint-get-value("settings", "default");
 }
 
-/**
- * Gets all breakpoint column values
- *
- * @access private
- *
- * @return {List}
- */
+///
+/// Gets all breakpoint column values
+///
+/// @access private
+///
+/// @return {List}
+///
 @function flint-get-all-columns() {
 	$all-keys: flint-get-all-keys();
 	$all-columns: ();
@@ -177,39 +177,39 @@
 	@return $all-columns;
 }
 
-/**
- * Returns the unit used in config
- *
- * @access private
- *
- * @return {*}
- */
+///
+/// Returns the unit used in config
+///
+/// @access private
+///
+/// @return {*}
+///
 @function flint-get-config-unit() {
 	@return unit(flint-get-value("settings", "gutter"));
 }
 
-/**
- * Convert pixel value to em
- *
- * @access private
- *
- * @param {Number} $target  - pixel value
- * @param {Number} $context - context to divide by
- *
- * @return {Number} em value of target relative to context
- */
+///
+/// Convert pixel value to em
+///
+/// @access private
+///
+/// @param {Number} $target  - pixel value
+/// @param {Number} $context - context to divide by
+///
+/// @return {Number} em value of target relative to context
+///
 @function flint-to-em($target, $context: $flint__base-font-size) {
 	@return ($target / $context) * 1em;
 }
 
-/**
- * Use Ruby functions in place of Sass functions where possible
- *   to speed up performance, especially with string functions
- *
- * @access private
- *
- * @return {Bool}
- */
+///
+/// Use Ruby functions in place of Sass functions where possible
+///   to speed up performance, especially with string functions
+///
+/// @access private
+///
+/// @return {Bool}
+///
 @function flint-use-ruby-functions() {
 	@return flint_use_ruby() == true;
 }