Skip to content

Commit

Permalink
Merge pull request #90 from Hypercubed/master
Browse files Browse the repository at this point in the history
Update readme and skip . paths in npm (e.g. .cache)
  • Loading branch information
Hypercubed committed Oct 9, 2016
2 parents 66e981e + 8634900 commit 439f305
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $ npm i --save credits

## Basic usage

`credits` will check all `node_modules` recursively and evaluate the **Author** and **Maintainers** of the **installed** dependencies included in the set path.
`credits` will check `node_modules`, `bower_components`, and `jspm_packages` to evaluate the **Author** and **Maintainers** of the **installed** dependencies included in the set path.

*In case you want to use it over the command line, there is also [credits-cli](https://github.com/stefanjudis/credits-cli).*

Expand Down Expand Up @@ -46,21 +46,21 @@ credits( creditPath )

/*
Will print:
[
{
name : 'Some person',
email : 'some@email.io',
packages : [ 'package1', 'package2', 'package3', 'package4', 'package5']
},
{
name : 'Some other great person',
email : 'someOther@email.io',
packages : [ 'package6', 'package7', 'package8' ]
},
...
...
...
]
{
npm:
[ { name : 'Some person',
email : 'some@email.io',
packages : [ 'package1', 'package2', 'package3', 'package4', 'package5'] },
{ name : 'Some other great person',
email : 'someOther@email.io',
packages : [ 'package6', 'package7', 'package8' ] },
...
...
...
],
jspm: [...],
bower: [...]
}
*/
```

Expand Down
2 changes: 1 addition & 1 deletion lib/analyzers/npm/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function getCredits( projectPath, credits, seen ) {
var directoryPath = path.join( depPath, name );

if (
name !== '.bin' &&
name[ 0 ] !== '.' &&
(
fs.lstatSync( directoryPath ).isDirectory() ||
fs.lstatSync( directoryPath ).isSymbolicLink()
Expand Down

0 comments on commit 439f305

Please sign in to comment.