https://github.com/nodesource/gather-dependencies

Similar in API to npm shrinkwrap producing a object structure with each type of dependency installed.
https://github.com/nodesource/gather-dependencies

Last synced: 5 months ago
JSON representation

Similar in API to npm shrinkwrap producing a object structure with each type of dependency installed.

• Host: GitHub
• URL: https://github.com/nodesource/gather-dependencies
• Owner: nodesource
• License: mit
• Created: 2015-09-21T23:35:59.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-06-07T18:24:21.000Z (over 9 years ago)
• Last Synced: 2024-12-18T00:12:53.472Z (about 1 year ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
gather-dependencies

===================

Similar in API to `npm shrinkwrap` producing a object structure with each type of dependency installed.

* dependencies

* devDependencies

* optionalDependencies

* peerDependencies

See the sample `npm-shrinkwrap.json` in ./test/fixtures/with-npm-install. With a shrinkwrapped file, dependencies saved with `npm shrinkwrap --dev` are grouped with other dependencies.

*`npm-shrinkwrap.json`*

```javascript

{

  "name": "without-npm-install",

  "version": "1.0.0",

  "dependencies": {

    "client-request": {

      "version": "1.0.1",

      "from": "client-request@*",

      "resolved": "https://registry.npmjs.org/client-request/-/client-request-1.0.1.tgz"

    },

    "tape": {

      "version": "4.2.0",

      "from": "tape@*",

      "resolved": "https://registry.npmjs.org/tape/-/tape-4.2.0.tgz",

    ...

```

`gather-dependencies` does not care about the resolved registry URI.

`gather-dependencies` adds the field `requestedVersion` for the user specified version in `package.json`.

Leaf nodes that do not have `version` or `from` already have the dependency satisfied. `npm shrinkwrap` ignores these entries.

## Examples

See [examples]('./examples').

*`gather-dependencies-report.json`*

```javascript

{

  "name": "gather-dependencies",

  "version": "1.0.0",

  "dependencies": {

    "read-package-tree": {

      "requestedVersion": "~5.1.0",

      "version": "5.1.0",

      "from": "read-package-tree@*",

      "dependencies": {

        "debuglog": {

          "requestedVersion": "^1.0.1",

          "version": "1.0.1",

          "from": "debuglog@>=1.0.1 <2.0.0"

        },

    ...

```

## Authors and Contributors

Dan ShawGitHub/dshawTwitter/@dshaw

Julian DuqueGitHub/julianduqueTwitter/@julian_duque

Daniel AristizabalGitHub/cronopioTwitter/@cronopio2

Adrian EstradaGitHub/edsadrTwitter/@edsadr

Contributions are welcomed from anyone wanting to improve this project!

## License & Copyright

**gather-dependencies** is Copyright (c) 2016 NodeSource and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.