github-hope
v0.3.32
Published
Github Projects Evaluator npm package, which used in HOPE
Downloads
6
Readme
github-hope
Github Projects Evaluator npm package, which used in HOPE
Installation
$ npm i --save github-hope
Usage
const hope = require('gihub-hope')
hope.evaluate('https://github.com/HackaIran/HOPE.git',someStrategy || null).then(result => {
console.log(result);
// { quality: 0.83,
// results:
// [ general: [ [Object], [Object], [Object], [Object] ],
// readme: [ [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object] ]
// ],
// .
// .
// . }
})
Scripts
npm run compile
- Compiles source files to disk (~/lib).npm run compile:watch
- Same asnpm run compile
but watches files for changes.npm run lint
- Lints source and test files.npm run lint:fix
- Lints files and attempts to fix any issues.npm run test
- Runs unit tests.npm run test:watch
- Same asnpm test
but watches files for changes.npm run test:cov
- Generates a test coverage report.
Distribution
Execute one of the following commands
npm version patch
npm version minor
npm version major
License
MIT