# deg-engine-less

> This is an engine which can be used in conjunction with [BGTM](https://www.npmjs.com/package/bgtm) for the purposes of compiling less files in a consistent and repeatable manner across every project in an agency.

Latest version **2.0.0** (published 2019-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install deg-engine-less
pnpm add deg-engine-less
yarn add deg-engine-less
bun add deg-engine-less
```

## 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 | 2.0.0 |
| Published | 2019-02-13 |
| First published | 2018-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ben Blanks |
| Maintainers | deepend |

## Links

- npm: https://www.npmjs.com/package/deg-engine-less
- npm.io page: https://npm.io/package/deg-engine-less

## Dependencies (7)

- [gulp-less](https://npm.io/package/gulp-less.md) ^4.0.0
- [deep-extend](https://npm.io/package/deep-extend.md) ^0.5.0
- [gulp-cssmin](https://npm.io/package/gulp-cssmin.md) ^0.2.0
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^1.2.2
- [gulp-plumber](https://npm.io/package/gulp-plumber.md) ^1.1.0
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^2.4.1
- [gulp-autoprefixer](https://npm.io/package/gulp-autoprefixer.md) ^4.0.0

## Recent versions

- 2.0.0 (latest) — 2019-02-13
- 1.0.0 — 2019-02-12
- 0.0.2 — 2018-03-01
- 0.0.1 — 2018-03-01

## README

# DEG - Engine for LESS Compilation

This is an engine which can be used in conjunction with
[BGTM](https://www.npmjs.com/package/bgtm) for
the purposes of compiling less files in a consistent and repeatable
manner across every project in an agency.

# How to use

Read the how to section for [BGTM](https://www.npmjs.com/package/bgtm).

Run:

    npm install --save-dev bgtm-engine-less

In your gulpfile add the following dependency:

    var less = require('bgtm-engine-less');

Then add the following task.

    tm.add('less', {
        runOnBuild: true,
        watch: true,
        watchSource: [
            'src/css/**/*.less'
        ],
        liveReload: true,
        engine: less,
        engineOptions: {
            'src': 'src/css/main.less',
            'dest': 'dest/css/'
        }
    });

# What it does

* Compiles the less file(s) specified in the `src` property using [gulp-less](https://www.npmjs.com/package/gulp-less)
* Runs [gulp-autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer) to automatically prefix any vendor specific prefixes to properties that are not yet fully released (e.g. `-ms-`, `-webkit-`, `-moz-`).
* Changes the extension of the output file to `.min.css`
* Generates and outputs a sourcemap file.
* Outputs them to the destination specified in the `dest` property.

Note: The compilation process is done using the outputStyle of
`expanded` unless BGTM is run in production mode.

You can do this with the following argument `gulp [optional task] --production`

# Engine Options

## Defaults

    {
        src: [],
        dest: '',
        autoprefixer: {
            browsers: [
                "iOS 7",
                "iOS 8",
                "last 2 versions"
            ],
            cascade: false
        }
    }

| Option       | Mandatory | Description |
|--------------|-----------|-------------|
| src          | yes       | The source path to look for changes, this can be an array of strings or a string. |
| dest         | yes       | The destination file for the compiled output to be placed into. |
| autoprefixer | no        | Can be configured using any options available in the [gulp-autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer) package |

# License

Copyright 2017 Deepend Sydney Pty Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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