README
bundler
SlimIO Archive bundler & Core compiler.
Requirements
- Node.js v12 or higher
Getting Started
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i @slimio/bundler
# or
$ yarn add @slimio/bundler
Usage example
TBC
API
generateAddonArchive(location: string, options?: ArchiveOptions): Promise< string >
Create Addon archive.
const { generateAddonArchive } = require("@slimio/bundler");
generateAddonArchive("F:\\Code\\Agent\\addons\\alerting", {
debug: true
}).catch(console.error);
generateCoreExecutable(location: string, options?: CoreOptions): Promise< string >
Compile the core. Options is described by the following interface
interface CoreOptions {
debug?: boolean;
cwd?: string;
}
const { generateCoreExecutable } = require("@slimio/bundler");
const { join } = require("path");
generateCoreExecutable("F:\\Code\\AgentTest", {
debug: true,
cwd: join(__dirname, "build")
});
}).then(() => console.log("core compiled")).catch(console.error);
Dependencies
Name | Refactoring | Security Risk | Usage |
---|---|---|---|
@slimio/arg-checker | Minor | Low | Argument Checker |
@slimio/is | Minor | Low | Type checker |
@slimio/manifest | Minor | Low | SlimIO manifest |
@slimio/tarball | ⚠️Major | High | SlimIO Addon & module archive tarball packer/extractor |
get-dir-size | Minor | Low | Get a directory size |
nexe | ⚠️Major | High | Create Node.js executable |
pretty-bytes | Minor | Low | Displaying file sizes for humans |
License
MIT