Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-a/package.js
a simple package (auto) loader for node.js apps which supports NPM or other package managers.
https://github.com/s-a/package.js
Last synced: about 5 hours ago
JSON representation
a simple package (auto) loader for node.js apps which supports NPM or other package managers.
- Host: GitHub
- URL: https://github.com/s-a/package.js
- Owner: s-a
- License: other
- Created: 2015-05-20T03:59:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-28T22:52:37.000Z (over 8 years ago)
- Last Synced: 2024-08-08T15:22:05.672Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 53
- Watchers: 8
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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
This software is dual licensed under MIT and GNU GENERAL PUBLIC LICENSE Version 3.
[
](/LICENSE.md#mit "Massachusetts Institute of Technology (MIT)")
[
](/LICENSE.md#gpl-30 "GNU GENERAL PUBLIC LICENSE Version 3")