You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
63 lines
3.4 KiB
Markdown
63 lines
3.4 KiB
Markdown
# package.js
|
|
[](https://travis-ci.org/s-a/package.js)
|
|
[](https://coveralls.io/r/s-a/package.js)
|
|
[](https://www.codacy.com/app/stephanahlf/package-js)
|
|
[](https://www.npmjs.org/package/package.js)
|
|
[](https://www.npmjs.org/package/package.js)
|
|
|
|
[](https://www.npmjs.org/package/package.js)
|
|
[](https://www.npmjs.org/package/package.js)
|
|
[](http://s-a.github.io/donate/)
|
|
|
|
## Open your node apps for plugin developers
|
|
package.js scans the given ```packageDirectories``` for your installed application packages and creates an instance by ```require```ing the main JavasScript file if a ```package.json``` file was found which contains expected package identifier(s). In the example case let us say ```{pandaPackage : true}```.
|
|
package.js will pass the ```packageContstructorSettings``` to the ```new``` ```require```d node module.
|
|
This implements an easy way to distribute packages akka addons or plugins for node applications via [NPM](https://npmjs.com) or other package distribution networks.
|
|
|
|
|
|
## Installation
|
|
```shell
|
|
npm install package.js --save;
|
|
```
|
|
|
|
## Example usage
|
|
```javascript
|
|
var path = require('path');
|
|
var events = require('events');
|
|
var packageController = require("package.js");
|
|
|
|
var CustomApp = function () {
|
|
this.events = new events.EventEmitter();
|
|
return this;
|
|
};
|
|
|
|
var customApp = new CustomApp();
|
|
|
|
packageController.autoload({
|
|
debug: true,
|
|
identify: function() {
|
|
return (this.meta.pandaPackage === true);
|
|
},
|
|
directories: [path.join(__dirname, "node_modules")],
|
|
packageContstructorSettings: {app:customApp}
|
|
});
|
|
```
|
|
To identify all application packages the method ```autoload``` expects a custom method called ```identify``` which is an event and will be executed for each package with the context of the package itself. So far you have access there to the following properties:
|
|
- ```this.dir``` - The package directory.
|
|
- ```this.meta``` - The package meta data fetched from its ```package.json```.
|
|
|
|
A package is marked as identified if ```identify()``` returns ```true (boolean)```.
|
|
A detailed demo of usage can be found in the [library tests](/test/main.js).
|
|
|
|
## Application Packages
|
|
Application packages are regular [NPM modules](https://docs.npmjs.com/getting-started/creating-node-modules) and must contain a file called [```package.json```](https://docs.npmjs.com/files/package.json) which is normaly used by [NPM](https://npmjs.com) but maybe with an extra field to identify your application plugins. Here is a very simple hello world [example package](/test-packages/package-1/)
|
|
|
|
## [Contributing](/CONTRIBUTING.md)
|
|
|
|
## [License](/LICENSE.md)
|
|
Copyright (c) 2015 Stephan Ahlf <stephan.ahlf@gmail.com>
|
|
This software is dual licensed under MIT and GNU GENERAL PUBLIC LICENSE Version 3.
|
|
|
|
[<img src="https://s-a.github.io/license/img/mit.svg" />](/LICENSE.md#mit "Massachusetts Institute of Technology (MIT)")
|
|
[<img src="https://s-a.github.io/license/img/gpl-3.0.svg" />](/LICENSE.md#gpl-30 "GNU GENERAL PUBLIC LICENSE Version 3")
|