{"analyzedAt":"2022-07-09T15:22:13.043Z","collected":{"metadata":{"name":"gulp-license-finder","scope":"unscoped","version":"1.0.0","description":"Find licenses of project and dependencies","keywords":["gulp","gulpplugin","license","license","finder","sniffer","nlf","audit","licence","checker","legal","dependency","nlf"],"date":"2017-05-06T19:38:16.726Z","author":{"name":"Ian Kelly"},"publisher":{"username":"iandotkelly","email":"iandotkelly@gmail.com"},"maintainers":[{"username":"iandotkelly","email":"iandotkelly@gmail.com"}],"repository":{"type":"git","url":"git://github.com/iandotkelly/gulp-license-finder.git"},"links":{"npm":"https://www.npmjs.com/package/gulp-license-finder","homepage":"https://github.com/iandotkelly/gulp-license-finder","repository":"https://github.com/iandotkelly/gulp-license-finder","bugs":"https://github.com/iandotkelly/gulp-license-finder/issues"},"license":"MIT","dependencies":{"nlf":"^2.0.0"},"devDependencies":{"gulp":"^3.9.0","gulp-jshint":"^2.0.4","gulp-util":"^3.0.6","jshint":"^2.9.4","mocha":"^3.3.0","should":"^11.2.1"},"releases":[{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2020-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1}],"hasTestScript":true,"readme":"## gulp-license-finder [![Build Status](https://secure.travis-ci.org/iandotkelly/gulp-license-finder.png)](http://travis-ci.org/iandotkelly/gulp-license-finder) [![Dependency Status](https://gemnasium.com/iandotkelly/gulp-license-finder.svg)](https://gemnasium.com/iandotkelly/gulp-license-finder)\n\n\n\n\n\n\n\n\n\n\n
DescriptionFinds licenses in node project and dependencies
Node Version>= 4
\n\n## Usage\n\n```javascript\nvar licenseFind = require('gulp-license-finder');\n\ngulp.task('licenses', function() {\n\treturn licenseFind()\n\t\t.pipe(gulp.dest('./audit'))\n});\n```\n\nThis will attempt to identify licenses in your node project and its dependencies, and will provide a file stream\nthat can be piped to an 'audit' destination folder. The file will have a default 'licenses.txt' filename.\n\nTo change the output filename, add the name as an argument to licenseFind, for example:\n\n```javascript\nvar licenseFind = require('gulp-license-finder');\n\ngulp.task('licenses', function() {\n\treturn licenseFind('outputfile.txt')\n\t\t.pipe(gulp.dest('./audit'))\n});\n```\n\n### Options\n\n#### options.directory\nType: `String`\nDefault value: `current project directory`\n\nA string value for the path of the node project to scan\n\n#### options.production\nType: `Boolean`\nDefault value: false\n\nA boolean value. If true, only production dependencies are included in the scan\n\n#### options.depth\nType: `Number`\nDefault value: if undefined this defaults to infinite\n\nThe maximum depth of node_modules to traverse, 0 means the immediate dependencies, add 1 per module depth\n\n#### options.csv\nType: `Boolean`\nDefault value: `./licenses.txt`\n\nA boolean value. If true the output is in a comma-separated-variable format for import into a spreadsheet.\n\n\n#### options.summaryMode\n\nType: `String`\nDefault value: `simple`\n\nWhether to print out the 'simple' or 'detail' summary at the end of the report.\n\n#### Usage examples:\n\n```javascript\nvar licenseFind = require('gulp-license-finder');\n\ngulp.task('licenses', function() {\n\treturn licenseFind('outputfile.txt', {\n\t\t\tdirectory: '/home/me/someproject',\n\t\t\tproduction: true,\n\t\t\tdepth: 5,\n\t\t\tcsv: true\n\t\t}).pipe(gulp.dest('./audit'))\n});\n```\n\n### Example output\n\n
\ncommander@0.6.1 [license(s): MIT]\n└── readme files: MIT\n\nread-installed@0.2.2 [license(s): BSD]\n└── license files: BSD\n\nglob@3.2.3 [license(s): BSD]\n├── package.json:  BSD\n└── license files: BSD\n\narchy@0.0.2 [license(s): MIT/X11]\n└── package.json:  MIT/X11\n\njson-stringify-safe@5.0.0 [license(s): BSD]\n├── package.json:  BSD\n└── license files: BSD\n\nshould@1.2.2 [license(s): MIT]\n└── readme files: MIT\n
\n\nFor output in CSV format use the csv: true option.\n\n### Unit tests\n\nThe majority of the tests for the functionality of this license finder are in the\n[nlf](https://www.npmjs.org/package/nlf) module. This plugin merely provides a gulp\nwrapper.\n\nTo run the gulp pluging unit tests (such as they are) you should have mocha installed\n(version ^1.21.4) and then run\n\n```sh\nnpm test\n```\n\n## LICENSE\n\n(The MIT License)\n\nCopyright (c) 2014-2017 Ian Kelly\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."},"npm":{"downloads":[{"from":"2022-07-08T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":3},{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":18},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":390},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1489},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":2575},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":4248}],"starsCount":0},"github":{"starsCount":29,"forksCount":7,"subscribersCount":2,"issues":{"count":2,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":1,"70858800":1,"212576400":0},"isDisabled":false},"contributors":[{"username":"iandotkelly","commitsCount":34}],"commits":[{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0}],"statuses":[{"context":"continuous-integration/travis-ci/push","state":"success"}]},"source":{"files":{"readmeSize":4169,"testsSize":1638,"hasChangelog":true},"badges":[{"urls":{"original":"https://secure.travis-ci.org/iandotkelly/gulp-license-finder.png","service":"https://api.travis-ci.org/iandotkelly/gulp-license-finder.svg","shields":"https://img.shields.io/travis/iandotkelly/gulp-license-finder.svg","content":"https://img.shields.io/travis/iandotkelly/gulp-license-finder.json"},"info":{"service":"travis","type":"build"}}],"linters":["jshint"]}},"evaluation":{"quality":{"carefulness":0.9199999999999999,"tests":0.85,"health":1,"branding":0.15},"popularity":{"communityInterest":39,"downloadsCount":496.3333333333333,"downloadsAcceleration":1.0072108066971084,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":0.9}},"score":{"final":0.664817217144239,"detail":{"quality":0.9565349727127667,"popularity":0.07968426049365344,"maintenance":0.9999063833075152}}}