Blame view

frontend/web/css/node_modules/gulp-less/README.md 5.25 KB
3da83322   Administrator   21.03.16 Versrka
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  gulp-less

  =========

  

  A LESS plugin for Gulp

  

  [![NPM Version](https://img.shields.io/npm/v/gulp-less.svg)](https://www.npmjs.com/package/gulp-less)

  [![Build Status](https://img.shields.io/travis/plus3network/gulp-less.svg)](https://travis-ci.org/plus3network/gulp-less)

  

  ## Installation

  

  ```

  npm install gulp-less

  ```

  

  ## Basic Usage

  

  ```js

  var less = require('gulp-less');

  var path = require('path');

  

  gulp.task('less', function () {

    return gulp.src('./less/**/*.less')

      .pipe(less({

        paths: [ path.join(__dirname, 'less', 'includes') ]

      }))

      .pipe(gulp.dest('./public/css'));

  });

  ```

  

  ## Options

  

  The options you can use [can be found here](http://lesscss.org/#using-less-configuration). Below is a list of valid options as of the time of writing:

  

  - `paths`: Array of paths to be used for `@import` directives

  - `plugins`: Array of less plugins ([details](#using-plugins))

  

  The `filename` option is not necessary, it's handled automatically by this plugin. The `compress` option is not supported -- if you are trying to minify your css, use [gulp-minify-css](https://github.com/jonathanepollack/gulp-minify-css). No `sourceMap` options are supported -- if you are trying to generate sourcemaps, use [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps).

  

  ## Minifying CSS

  

  If you want to minify/compress your css, you can use either the [gulp-minify-css](https://github.com/jonathanepollack/gulp-minify-css) plugin for gulp, or the [less-clean-css](https://github.com/less/less-plugin-clean-css) plugin for less. Examples of both are shown below:

  

  ```js

  // Using a less plugin to minify css

  var LessPluginCleanCSS = require('less-plugin-clean-css'),

      cleancss = new LessPluginCleanCSS({ advanced: true });

  

  gulp.src('./less/**/*.less')

    .pipe(less({

      plugins: [cleancss]

    }))

    .pipe(gulp.dest('./public/css'));

  ```

  

  ```js

  // Using a gulp plugin to minify css

  var minifyCSS = require('gulp-minify-css');

  

  gulp.src('./less/**/*.less')

    .pipe(less())

    .pipe(minifyCSS())

    .pipe(gulp.dest('./public/css'));

  ```

  

  ## Using Plugins

  

  Less now supports plugins, which can add additional functionality like minifying css as shown above. Here's an example of how to use plugins with `gulp-less` using both the [clean-css plugin](https://github.com/less/less-plugin-clean-css) and the [autoprefix plugin](https://github.com/less/less-plugin-autoprefix).

  

  ```js

  var LessPluginCleanCSS = require('less-plugin-clean-css'),

      LessPluginAutoPrefix = require('less-plugin-autoprefix'),

      cleancss = new LessPluginCleanCSS({ advanced: true }),

      autoprefix= new LessPluginAutoPrefix({ browsers: ["last 2 versions"] });

  

  gulp.src('./less/**/*.less')

    .pipe(less({

      plugins: [autoprefix, cleancss]

    }))

    .pipe(gulp.dest('./public/css'));

  ```

  

  More info on LESS plugins can be found at http://lesscss.org/usage/#plugins, including a current list of all available plugins.

  

  ## Source Maps

  

  `gulp-less` can be used in tandem with [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) to generate source maps for your files. You will need to initialize [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) prior to running the gulp-less compiler and write the source maps after, as such:

  

  ```js

  var sourcemaps = require('gulp-sourcemaps');

  

  gulp.src('./less/**/*.less')

    .pipe(sourcemaps.init())

    .pipe(less())

    .pipe(sourcemaps.write())

    .pipe(gulp.dest('./public/css'));

  ```

  

  By default, [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) writes the source maps inline in the compiled CSS files. To write them to a separate file, specify a relative file path in the `sourcemaps.write()` function, as such:

  

  ```js

  var sourcemaps = require('gulp-sourcemaps');

  

  gulp.src('./less/**/*.less')

    .pipe(sourcemaps.init())

    .pipe(less())

    .pipe(sourcemaps.write('./maps'))

    .pipe(gulp.dest('./public/css'));

  ```

  

  ## Error Handling

  

  By default, a gulp task will fail and all streams will halt when an error happens. To change this behavior check out the error handling documentation [here](https://github.com/gulpjs/gulp/blob/master/docs/recipes/combining-streams-to-handle-errors.md)

  

  ## License

  

  (MIT License)

  

  Copyright (c) 2015 Plus 3 Network dev@plus3network.com

  

  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.