A package parser that can resolve self and dependencies, supporting spm / component.
$ npm install father -g
// using SpmPackage
var Package = require('father').SpmPackage;
var pkg = new Package('path/to/package')
console.log(pkg.name);
console.log(pkg.version);
console.log(pkg.main);
console.log(pkg.dependencies); // return a object contains dependencies
console.log(pkg.get('each')); // return a package named each
// using ComponentPackage
var Package = require('father').ComponentPackage;
The properties of Package instance
Unique id for each package
= {pkg.name}@{pkg.version}
Package's name
Package's version
Entry point of the package, default is index.js
Package's dependencies, each one will return a Package instance
All used files will exist in pkg.files, it will be parsed from pkg.main. Each file contains dependent files (no deep dependencies).
Example below
{
files: {
'index.js': {
dependencies: ['each', './feature']
}
}
}
The base directory of the package
The origin package info
Export files when build
Get a package by id
Set a package
Get all dependent packages
Get file object by given path
Get all file objects
The options when instantiation
new Package('path/to/package', options);
Generally, files will be parsed from pkg.main, no dependent file will not be included. entry
will be another entry point.
Files
// a.js <- pkg.main
console.log('no require');
// b.js
require('./c');
// c.js
console.log('no require');
Code
new Package('path/to/package', {
entry: ['b.js']
});
Return
// without entry
{
...
files: {
'a.js': []
}
}
// with entry
{
...
files: {
'a.js': [],
'b.js': ['./c'],
'c.js': []
}
}
// a.js
require('b')
If you want to skip file or package, you can specify skip. And it won't parse b and won't exist in dependencies.
new Package('path/to/package', {
skip: ['b']
});
yield
define('a', [], function(require) {
require('b')
});
Almost same as skip, however it will exist in dependency.
Where is your modules
what you get in pkg.files is file objects that is extending vinyl.
var fileObj = pkg.files['a.js'];
fileObj.pkg
fileObj.relative
fileObj.extension
fileObj.path // = fileObj.pkg.dest + fileObj.relative
lookup all dependencies and can be filtered or transformed in callback
fileObj.lookup(function(fileInfo) {
// fileInfo.path: filepath of fileinfo
// fileInfo.relative: filepath based on packagge
// fileInfo.pkg: package info
// fileInfo.isRelative: required by file in the same package
// fileInfo.dependent: dependent package
// fileInfo.extension: exntesion of the file
return fileInfo.filepath;
return false; // ignore
});
Determine whether it has the matched extension in all dependencies.
fileObj.hasExt('css'); // return false
If you want to use it for your package, you can extend Package and override readPackage.
var Package = require('father').Package;
var Custom = Package.extend({
readPackage: function() {
// 1. read config file, E.g. component.json
// 2. return a package contains id, name, version, dependencies, main, dest, files, origin
// 3. dependencies should contain id, name, version, dest
};
})
Example for returned object by readPackage
{
id: 'a',
name: 'a'
version: '1.0.0',
main: 'index.js',
dest: '/home/user/a',
dependencies: {
b: {
id: 'b@1.1.0',
name: 'b',
version: '1.1.0',
dest: '/home/user/a/components/b'
}
}
}
Copyright (c) 2014 popomore. Licensed under the MIT license.