A command-line tool to help identify problems with GFP modules
npm install gfp-doctor -g
When in a GFP repository folder, run gfp-doctor
Usage: gfp-doctor [options]
Options:
-h, --help output usage information
-V, --version output the version number
-v, --verbose
package.json
- Should use
eslint-config-gfp
- Should use public npm version of
eslint-config-gfp
- Should use public npm version
angular-module-no-deps
- Should use
documentation
- Should use
.eslintrc
- Should use
valid-jsdoc
rule - Should use
require-jsdoc
rule
- Should use
karma.conf.js
- Should use
angular
andangular-mocks
fromnode_modules
- Should use
bower.json
- Should not have
"version"
property
- Should not have
Create a branch or fork, then submit PR.
Remember to:
- Update CHANGELOG.md
- Update README.md
npm run lint
Please respect the .editorconfig
and .eslintrc
. Basically:
- UTF-8
- Unix linebreaks
- 4 space indentation
- Semicolons
- Create a new file in
/lib
and require it inlib/index.js
- The new file should return an array with the following format to the
run
function inlib/index.js
:
[
{
desc: 'a description of the test being made',
errorMsg: 'a descriptive error message and proposed solution',
passed: Boolean
},
{...}
]