Package Exports
- component-resolver
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (component-resolver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
component-resolver 
Resolve a component's dependency tree.
- Relies on components' newer specs
- Validates and normalizes
component.json
s - Supports installing components
- Supports globs for both remote and local components
- Supports semver resolution for dependencies
This uses:
- remotes - normalize remote end points
- downloader - downloads repositories
- flatten - flatten a dependency tree into a list
Example
var resolve = require('component-resolver');
var flatten = require('component-flatten');
resolve({
// a "component.json"
dependencies: {
'component/emitter': '1.1.1'
}
}, function (err, tree) {
if (err) throw err;
tree.dependencies['component/emitter'];
/**
* name: 'component/emitter'
* version: '1.1.1'
* ref: '1.1.1'
*/
// flatten the dependency tree
var nodes = flatten(tree);
nodes[0].name === 'component/emitter';
});
API
resolve(component, [options], [callback])
component
can either be a "root" folder. If null
, it's process.cwd()
. component
can also be "component.json" object. This is useful for resolving dependencies without reading anything from disk.
The main options
are:
root
<process.cwd()> - ifcomponent.json
is an object, this will set the root.remote
- aremotes
instance. Defaults to the localdir
andgithub
.dev
- include development
inlocal
componentsdeps
- resolve dependencies verbose
- print warnings concurrency
<{}> - an object with concurrency values for different channels. Defaults:locals: 16
dependencies: 5
semver: 5
installs: 5
downloads: 1
Options passed to component-downloader
:
install
- install components to out
dir
<components
> - folder to install components tofields
archive
callback
is a function with signature (err, tree)
. You if no callback is set, a generator is returned.
resolve(root, options, function (err, tree) {
})
// or if you use generators
co(function* () {
var tree = yield* resolve(root, options);
})
tree and branches
This resolver returns a tree
. The tree consists of branches
that connect nodes
. Each node
is the relevant component.json
. Thus, you can view the branches
as how each component relates to each other as well as additional metadata.
There are two types of branches: local
for local components and dependency
for remote components. Properties:
type
- eitherlocal
ordependency
name
canonical
- a canonical, unique name for this component. For remote dependencies, this is<user>/<project>@<reference>
. For local components, this is the relative path fromroot
to this component'spath
.dependencies
{} - remote dependencies of this componentlocals
{} - local dependencies of this componentdependents
[] - dependents of this componentnode
- the node'scomponent.json
path
- the path of the component, not including/component.json
.filename
- the filename of thiscomponent.json
paths
- absolute.paths
of this component.paths
are inherited from their parent.remotes
- list of remote names to lookup dependencies of this component.remotes
are inherited from their parent.resolvedRemotes
- a list of all the remotes, including this component's parents'
Dependencies have:
ref
- git reference such asmaster
,v1.0.0
, etc.version
- the semantic version, if any
var nodes = resolve.flatten(tree)
Flattens a tree for building in the proper dependency order. You can also manipulate the tree if you'd like. Read more about component-flatten.
License
The MIT License (MIT)
Copyright (c) 2014 Jonathan Ong me@jongleberry.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.