A port of the grunt-sloc plugin for gulp
npm install gulp-slocgulp-sloc
=========
A port of the grunt-sloc plugin for gulp with some minor changes.





First install the gulp-sloc plugin as a development dependency:
``shell`
npm install --save-dev gulp-sloc
Then, add it to your gulpfile.js:
`javascript
var sloc = require('gulp-sloc');
gulp.task('sloc', function(){
gulp.src(['scripts/*.js'])
.pipe(sloc());
});
`
This would output the following:
`shell`
[gulp] -------------------------------
[gulp] physical lines : 135
[gulp] lines of source code : 97
[gulp] total comment : 5
[gulp] singleline : 5
[gulp] multiline : 0
[gulp] empty : 33
[gulp]
[gulp] number of files read : 2
[gulp] strict mode
[gulp] -------------------------------
#### options.tolerant
Type: Booleanfalse
Default:
Set as false to analyze only files with a subset of popular extensions. true to analyze files with any file extension. The default is false.
If true, the SLOC will be executed on all of the files specified, regardless of file extension. With tolerant set to false, or unspecified, only supported file extensions will be analyzed.
#### options.reportType
Type: Stringstdout
Default:
It will generate a JSON file with the SLOC analysis results and sends it further downstream. Use with the reportFile option if you want to customize the file name. You may want to pipe to the gulp.dest() method to write it out to specified folder. Example:
`javascript
var sloc = require('gulp-sloc');
gulp.task('sloc', function(){
gulp.src(['lib/*/.js'])
.pipe(sloc({
reportType: 'json'
}))
.pipe(gulp.dest('./reports/'));
});
`
Would output the following in the file ./reports/sloc.json:
` js`
{"loc":138,"sloc":100,"cloc":5,"scloc":5,"mcloc":0,"nloc":33,"file":2}
#### options.reportFile
Type: Stringsloc.json
Default:
The name of the file which would contain you'd like to output the JSON file. Use with the json as reportType. Ignored if used with the stdout report type. Example:
` js
var sloc = require('gulp-sloc');
gulp.task('sloc', function(){
gulp.src(['./test/*/.js'])
.pipe(sloc({
reportType: 'json',
reportFile: 'testSloc.json'
}))
.pipe(gulp.dest('./reports/'));
});
`
Would output the sloc results in the file ./reports/testSloc.json.
- JavaScript - jscoffee
- CoffeeScript - or coffeescriptc
- C / C++ - or ccpy
- Python - java
- Java - php
- PHP -
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)git commit -am 'Add some feature'
3. Commit your changes ()git push origin my-new-feature`)
4. Push to the branch (
5. Create new Pull Request