cleecanth / sass-tools

Central location for my sass tools

sass-tools

Central location for framework sass tools

→ View API docs

→ View sample config

Installation

# Yarn (preferred)
yarn add @uwhealth/sass-tools --dev

# NPM
npm install @uwhealth/sass-tools --save-dev

Usage

Before using sass-tools, you need to import the main entry point (index.scss) and initialize the tools. Initializing will take your configuration variables and move them to private variables used by functions and mixins elsewhere.

@import 'path/to/node_modules/@uwhealth/sass-tools/index';

// Set configuration variables
// Docs here: https://uwhealth.github.io/sass-tools/#config
// Example config here: https://github.com/UWHealth/sass-tools/blob/master/example-config.scss
// ...

// Initialize (populates configuration)
@include init;

An example configuration — for easy copy-and-paste — can be found at the root of this repo.

Deployment (publishing to npm)

Since these tools are relied on by other UW Health projects, they are available on npm. To make new versions available to npm, your new changes must be pushed to the master branch before publishing to npm.

Once your changes are pushed, you can use one of the following commands to ease the publishing/tagging process:

NOTE: You must be logged in to github and npm prior to running these commands or they will fail.

Maintenance updates (patches)

npm run patch

Minor updates (new functionality)

npm run minor

Major updates (breaking changes)

npm version major && npm publish

All commands will tag the most recent changes, update the version in package.json, and push that tag to git. The changes will then be packaged and added to npm.