Repository files navigation

A port of thegrunt-sloc plugin for gulp with some minor changes.

First install thegulp-sloc plugin as a development dependency:

npm install --save-dev gulp-sloc

Then, add it to yourgulpfile.js:

varsloc=require('gulp-sloc');gulp.task('sloc',function(){gulp.src(['scripts/*.js']).pipe(sloc());});

This would output the following:

[gulp] -------------------------------[gulp]         physical lines: 135[gulp]   lines ofsource code: 97[gulp]          total comment: 5[gulp]             singleline: 5[gulp]              multiline: 0[gulp]                  empty: 33[gulp][gulp]   number of filesread: 2[gulp]            strict mode[gulp] -------------------------------

Type:BooleanDefault:false

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. Withtolerant set tofalse, or unspecified, only supported file extensions will be analyzed.

Type:StringDefault:stdout

It will generate a JSON file with the SLOC analysis results and sends it further downstream. Use with thereportFile option if you want to customize the file name. You may want to pipe to thegulp.dest() method to write it out to specified folder. Example:

varsloc=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:

{"loc":138,"sloc":100,"cloc":5,"scloc":5,"mcloc":0,"nloc":33,"file":2}

Type:StringDefault:sloc.json

The name of the file which would contain you'd like to output the JSON file. Use with thejson asreportType. Ignored if used with thestdout report type. Example:

varsloc=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 -js
• CoffeeScript -coffee orcoffeescript
• C / C++ -c orcc
• Python -py
• Java -java
• PHP -php

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request