# node-jeet-sass

> node-sass wrapper for thoughtbot's jeet library

Latest version **0.1.5** (published 2015-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-jeet-sass
pnpm add node-jeet-sass
yarn add node-jeet-sass
bun add node-jeet-sass
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2015-09-01 |
| First published | 2015-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Volkov Dmitriy |
| Maintainers | v-dmitriy-s |
| Keywords | sass, css |

## Links

- npm: https://www.npmjs.com/package/node-jeet-sass
- Repository: https://github.com/v-dmitriy-s/node-jeet-sass
- Homepage: https://github.com/v-dmitriy-s/node-jeet-sass#readme
- Issues: https://github.com/v-dmitriy-s/node-jeet-sass/issues
- npm.io page: https://npm.io/package/node-jeet-sass

## Dependencies (1)

- [jeet](https://npm.io/package/jeet.md) 6.1.2

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

- 0.1.5 (latest) — 2015-09-01

## README

# node-jeet-sass
[![Jeet Sass Mixin Library](http://jeet.gs/img/jeet-logo-color.svg)](http://jeet.gs)

*This is a node-sass port of the [Jeet](http://jeet.gs) library (version 6.1.2).

[![Build Status](https://travis-ci.org/v-dmitriy-s/node-jeet-sass.svg?branch=master)](https://travis-ci.org/v-dmitriy-s/node-jeet-sass)

# Contents

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
  - [Basic Usage](#basic-usage)
  - [gulp.js](#gulpjs-usage)
  - [Grunt](#grunt-usage)
  - [node-sass](#node-sass-usage)
- [License](#license)

# Requirements
- [node](http://nodejs.org)
- [gulp.js](http://gulpjs.com) 
- [Grunt](http://gruntjs.com) 
- [node-sass](https://github.com/andrew/node-sass)

# Installation

To install as a development dependency, run:

```bash
npm install --save-dev node-jeet-sass
```

If you need it in production, replace `--save-dev` with `--save`.

# Usage

## Basic Usage

To use `node-jeet-sass` with tools like [gulp.js](#gulpjs-usage), [Grunt](#grunt-usage), or directly with [node-sass](#node-sass-usage), provide the path to Jeet in your Sass config. There are a couple of convenience methods for this, depending on whether you want Sass to include additional directories or not.

### with() Function

The `with()` function will include any additional paths you pass as arguments.

Returns an array of paths.

```javascript
var jeet = require('node-jeet-sass');
// Any of these will return an array of Jeet paths plus your custom path(s)
jeet.with('path/to/stylesheets')
jeet.with('path/to/stylesheets1', 'path/to/stylesheets2')
jeet.with(['path/to/stylesheets1', 'path/to/stylesheets2'])
```

### includePaths Property

The `includePaths` property returns an array of Jeet's paths to use in your config.

```javascript
var jeet = require('node-jeet-sass');
jeet.includePaths // Array of Jeet paths
```

### Stylesheet usage

Use either method above with the Sass config for your chosen tool (gulp.js, Grunt, etc.), then it's business as usual for Jeet in your stylesheet:

```scss
@import "jeet";
```

## gulp.js Usage

Using the [gulp-sass](https://github.com/dlmanning/gulp-sass) plugin.

```javascript
var gulp = require('gulp');
var sass = require('gulp-sass');

gulp.task('sass', function () {
  gulp.src('path/to/input.scss')
    .pipe(sass({
      // includePaths: require('node-jeet-sass').with('other/path', 'another/path')
      // - or -
      includePaths: require('node-jeet-sass').includePaths
    }))
    .pipe(gulp.dest('path/to/output.css'));
});
```

## Grunt Usage

### Using *grunt-sass*

The [grunt-sass](https://github.com/sindresorhus/grunt-sass) task uses
[node-sass](https://github.com/andrew/node-sass)
([LibSass](https://github.com/hcatlin/libsass)) underneath, and is the recommended
way to use Grunt with node-jeet-sass.

Example config:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        // includePaths: require('node-jeet-sass').with('other/path', 'another/path')
        // - or -
        includePaths: require('node-jeet-sass').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

### Using *grunt-contrib-sass*

If you are using the Ruby version of Sass with node-jeet-sass, then you will need to use
the [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) task instead.

*Note that node-jeet-sass is __NOT__ tested against the __Ruby__ version – only against __LibSass__.*

Example config:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        // loadPath: require('node-jeet-sass').with('other/path', 'another/path')
        // - or -
        loadPath: require('node-jeet-sass').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

## node-sass Usage

Using it directly with [node-sass](https://github.com/andrew/node-sass).

```javascript
var sass    = require('node-sass')
var jeet = require('node-jeet-sass');

sass.render({
  file: './application.scss',
  success: function(css){
    console.log(css);
  },
  error: function(error) {
    console.log(error);
  },
  // includePaths: jeet.with('other/path', 'another/path'),
  // - or -
  includePaths: jeet.includePaths,
  outputStyle: 'compressed'
});
```

# License

node-jeet-sass is Copyright © 2015 Volkov Dmitriy. It is free software, and may be redistributed under the terms specified in the LICENSE file.
此节点由safari插件自动生成

---
_Source: https://npm.io/package/node-jeet-sass · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._