jigsass-tools-strings

JigSass Tools Strings

String manipulation helper functions

Installation

Using npm:

npm i -S jigsass-tools-strings

Usage

@import 'path/to/jigsass-tools-strings';

Documentation of jigsass-tools-strings functionality is available at https:txhawks.github.io/jigsass-tools

Documention

Sass

Documentation of JigSass Strings's features is generated by SassDoc.

Run gulp serve:sassdoc to fire up a live server serving the documentation.

To generate documentation from annotation in the source code, run gulp sass:doc.

Development

It is a best practice for JigSass modules to not automatically generate css on @import, but 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 Strings in any way you see fit.

Writing documentation

Good documentation is crucial for scalability and maintainability. When submitting code jigsass-tools-strings please do make sure that all of its Sass functionality (functions, mixins, variables and placeholder selectors) are fully documented.

As mentioned above, the Sass is documented using SassDoc (Documention).

Running tests

gulp lint will, well, lint the contents scss files in the scss directory.

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.

Writing tests

JigSass Tools Strings tests are written using Sassaby and Mocha. Spec files are located in the test directory.

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 test_*.js file. We can also require() files and assign them to the global object to make them available to all test_*.js files.

jigsass-tools-strings uses a file called helper.js can be used to set up mocha globals requires and before().

In addition to Sassaby's testing functions, jigsass-tools-strings makes a few Sass functions available to the test suite, for use inside Sassaby tests:

jig-var-equals($value, $var) -> {boolean}

Check if a variable equals a value.
$value {*}: A value to compare the value of $var to.
$var {*}: The variable to test

jig-var-type-is($type, $var) -> {boolean}

Check if a variable is of a certain type.
$type {string}: A type to compare with the type of $var.
$var {*}: The variable to test

jig-map-key-equals($value, $map, $keys...) -> {boolean}

Check if a map's key is assigned a cerain value.
$value {*}: A value to compare the value of a key in $map with.
$map {map}: The map to test.
$keys... {arglist}: A recursive chain of keys.

jig-map-key-type-is($type, $map, keys...) -> {boolean}

Check if a map's key is of a certain type
$type {string}: A type to compare with the type of $var.
$map {map}: The map to test.
$keys... {arglist}: A recursive chain of keys.

File structure

┬ ./
│
├─┬ scss/ 
│ └─ index.scss # The module's importable file.
│
├── sassdoc/    # Generated documentation 
│               # of the module's sass features
│
└─┬─ test/
  │
  ├─┬ helpers/
  │ │
  │ ├── importer.scss       # Used for easilty importing tested scss files
  │ │
  │ └── _test_helpers.scss  # JigSass's assertion helpers,
  │                         # for use inside Sassaby tests.
  │                         
  ├── helper.js              # Used for defining global `before()`
  │                          # functions and requiring modules.
  │                         
  └── test_jigsass-tools-strings  # Specs. Mocha will automatically 
                             # run all javascript files located
                             # in the `test` directory.

License: MIT