Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme and skip . paths in npm (e.g. .cache) #90

Merged
merged 4 commits into from
Oct 9, 2016
Merged

Update readme and skip . paths in npm (e.g. .cache) #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d4de3db
Skip all . paths in npm analyzer
Hypercubed Oct 9, 2016
2fe5c4e
Update readme
Hypercubed Oct 9, 2016
d41cf76
Upadte readme to show jspm and bower support
Hypercubed Oct 9, 2016
8634900
Fix linting
Hypercubed Oct 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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