Map helper functions
npm i -S jigsass-tools-maps
@import 'path/to/jigsass-tools-maps/index.scss'; should give you all you need.
jigsass-tools-maps provides the following utility functions:
For further details, see the documentation located in The
Documentation of JigSass Tools Maps's Sass features is generated by SassDoc.
gulp serve:sassdoc to fire up a live server serving the documentation.
To generate documentation from annotation in the source code, run
To disable the generation of sass documentation, create an empty
file at the root jigsass-tools-maps directory.
It is a best practice for JigSass modules to not automatically generate css on
rather have to user explicitly enable the generation of specific styles from the module.
Contributions in the form of pull-requests, issues, bug reports, etc. are welcome. Please feel free to fork, hack or modify JigSass Tools Maps in any way you see fit.
Good documentation is crucial for scalability and maintainability. When writing your module, please do make sure that both its Sass functionality (functions, mixins, variables and placeholder selectors), as well as the CSS it generates (selectors, concepts, usage exmples, etc.) are well documented.
As mentioned above, the Sass is documented using SassDoc (Documention).
gulp lint will, well, lint the contents scss files in the
gulp test with run module's test using Mocha and Sassaby.
gulp tdd will watch both the Sass files and the test specs for changes, and will
run tests automatically upon them.
JigSass Tools Maps tests are written using Sassaby
and Mocha. Spec files are located in the
Mocha allows us to place a call to
before() in the root of any test file and it
will be run once, before all the other tests in every
We can also
require() files and assign them to the global object to make them
available to all
jigsass-tools-maps uses a file called
helper.js can be used to set up mocha
globals requires and
In addition to Sassaby's testing functions, jigsass-tools-maps makes a few Sass functions available to the test suite, for use inside Sassaby tests: