https://github.com/uwhealth/sass-tools

Central location for UW Health's sass tools
https://github.com/uwhealth/sass-tools

sass sass-boilerplate sass-functions sass-library sass-mixins

Last synced: 3 days ago
JSON representation

Central location for UW Health's sass tools

• Host: GitHub
• URL: https://github.com/uwhealth/sass-tools
• Owner: UWHealth
• License: mit
• Created: 2018-07-02T16:49:32.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-08T05:20:57.000Z (about 1 year ago)
• Last Synced: 2024-09-21T18:18:35.107Z (7 days ago)
• Topics: sass, sass-boilerplate, sass-functions, sass-library, sass-mixins
• Language: SCSS
• Homepage: https://uwhealth.github.io/sass-tools/
• Size: 1.34 MB
• Stars: 2
• Watchers: 6
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sass-tools

Central location for framework sass tools

[→ View API docs](https://uwhealth.github.io/sass-tools/)

[→ View sample config](example-config.scss)

## Installation

```cli

# 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.

```scss

@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](https://github.com/UWHealth/sass-tools/blob/master/example-config.scss) — 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](https://www.npmjs.com/package/@uwhealth/sass-tools).

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)**

```cli

npm run patch

```

**Minor updates (new functionality)**

```cli

npm run minor

```

**Major updates (breaking changes)**

```cli

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.