# jigsass-tools-maps > Map helper functions Latest version **1.0.10** (published 2016-04-25) · MIT license · 0 weekly downloads ## Install ```sh npm install jigsass-tools-maps pnpm add jigsass-tools-maps yarn add jigsass-tools-maps bun add jigsass-tools-maps ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.10 | | Published | 2016-04-25 | | First published | 2016-03-03 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | Author | TxHawks | | Maintainers | txhawks | | Keywords | jigsass, sass, scss, css, oocss, atomic css, eyeglass-module | ## Links - npm: https://www.npmjs.com/package/jigsass-tools-maps - Repository: https://github.com/txhawks/jigsass-tools-maps - Homepage: https://github.com/txhawks/jigsass-tools-maps#readme - npm.io page: https://npm.io/package/jigsass-tools-maps ## Alternatives - [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads - [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads - [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads - [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads - [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads ## Recent versions - 1.0.10 (latest) — 2016-04-25 - 1.0.9 — 2016-04-22 - 1.0.8 — 2016-04-12 - 1.0.7 — 2016-04-10 - 1.0.6 — 2016-04-02 - 1.0.5 — 2016-03-16 - 1.0.4 — 2016-03-16 - 1.0.3 — 2016-03-09 - 1.0.2 — 2016-03-06 - 1.0.1 — 2016-03-06 - 1.0.0 — 2016-03-03 ## README # JigSass Tools Maps [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] > Map helper functions ## Installation Using npm: ```sh npm i -S jigsass-tools-maps ``` ## Usage `@import 'path/to/jigsass-tools-maps/index.scss';` should give you all you need. `jigsass-tools-maps` provides the following utility functions:
jigsass-get
Get a value from nested maps
jigsass-set
Set a value in nested maps
jigsass-deep-has-key
Check if a map has a nested key
jigsass-merge-deep
Recursively assign values from multiple maps into a single map
For further details, see the documentation located in The `sassdoc` directory. ## Documention Documentation of JigSass Tools Maps's Sass features is generated by [SassDoc](http://sassdoc.com). 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`. To disable the generation of sass documentation, create an empty `noSassDoc` file at the root jigsass-tools-maps directory. ## 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 Maps in any way you see fit. #### Writing documentation 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](http://sassdoc.com/annotations/)). #### 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 Maps tests are written using [Sassaby](https://github.com/ryanbahniuk/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-maps 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-maps 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 ```bash ┬ ./ │ ├─┬ 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-maps # Specs. Mocha will automatically # run all javascript files located # in the `test` directory. ``` **License:** MIT [npm-image]: https://badge.fury.io/js/jigsass-tools-maps.svg [npm-url]: https://npmjs.org/package/jigsass-tools-maps [travis-image]: https://travis-ci.org/TxHawks/jigsass-tools-maps.svg?branch=master [travis-url]: https://travis-ci.org/TxHawks/jigsass-tools-maps [daviddm-image]: https://david-dm.org/TxHawks/jigsass-tools-maps.svg?theme=shields.io [daviddm-url]: https://david-dm.org/TxHawks/jigsass-tools-maps --- _Source: https://npm.io/package/jigsass-tools-maps · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._