website·Indexed 31 days ago
https://bajo.appA framework for rapid application development featuring a plugin-based ecosystem and system hooks. Documentation covers v2.0.x, including installation, configuration, system architecture, and plugin development.
Bajo uses a plugin-based architecture. The main plugin is defined in main/index.js using a factory function. The plugin lifecycle consists of three primary asynchronous methods: init (initialization), start (execution), and exit (cleanup).
Plugins are configured via JSON files at {dataDir}/config/{pluginName}.json. Default configuration values should be defined in the plugin's constructor to ensure they are merged correctly with the JSON config.
// main/index.js
async function factory (pkgName) {
const me = this
return class Main extends this.app.pluginClass.base {
constructor () {
super(pkgName, me.app)
// Define default config here
this.config = {
firstName: 'John',
lastName: 'Doe',
age: 50
}
}
init = async () => {
// Values from data/config/main.json are merged into this.config
this.firstName = this.config.firstName
this.lastName = this.config.lastName
this.age = this.config.age
}
start = async () => {
this.log.info('First name: %s, Last name: %s, age: %d', this.firstName, this.lastName, this.age)
}
exit = async () => {
this.log.warn('Program aborted')
}
}
}
export default factory// data/config/main.json
{
"firstName": "Tanjiro",
"lastName": "Kamado",
"age": 15
}Bajo uses specific terms to describe the project environment and plugin architecture:
{appDir}: The root project directory containing the application code.{dataDir}: The directory for all data and configuration; defaults to {appDir}/data and is created automatically if missing.{tmpDir}: The temporary directory, defaulting to the OS temporary directory.{pkgName}: The plugin's npm package name.{ns}: The plugin namespace (the camel-cased version of the package name).{mainNs}: The special 'main' namespace and directory within {appDir} where application-specific code resides.bajo-cli plugin.# Install the CLI plugin
npm install bajo-cli
# OR
yarn add bajo-clibajo-cli to the data/config/.plugins file.-a or --applet switch:node index.js -a
# OR
bun index.js -aTo enable logs while in applet mode (which are disabled by default), add the --log-applet switch.
A typical Bajo application follows this structure:
{appDir}/main/: The application code directory (the {mainNs} plugin). It is always available, starts last, and is created automatically if missing.index.js: The factory function for the main plugin.extend/: Directory for extending other plugins.{dataDir}/ (Default: {appDir}/data): The only directory where Bajo is permitted to write data.config/: Contains configuration files..plugins: Defines which plugins to load.bajo.json: Global settings.{ns}.json: Plugin-specific configuration files.plugins/: Plugin data storage.index.js: The main entry point for the application.package.json: Project dependencies and metadata.main/extend/bajo/hook/ directory, or trigger your own custom hooks using runHook from the app.bajo object.// Example: Tapping into a system hook
// File: main/extend/bajo/hook/afterBootComplete.js
async function afterBootComplete () {
this.log.info('Hook after boot complete')
}
export default afterBootComplete// Example: Triggering a custom hook in a plugin
init = async () => {
const { runHook } = this.app.bajo
// ... initialization logic ...
await runHook('main:myHook')
}afterBootComplete) or define custom hooks within a plugin's lifecycle using this.app.bajo.runHook('hookName').// Example: Tapping a built-in hook
// File: main/extend/bajo/hook/afterBootComplete.js
async function afterBootComplete () {
this.log.info('Hook after boot complete')
}
export default afterBootComplete
// Example: Triggering a custom hook in a plugin
init = async () => {
const { runHook } = this.app.bajo
// ... initialization logic ...
await runHook('main:myHook')
}To use plugins in the Bajo Framework:
npm install {pkgName}.{dataDir}/config/{ns}.json to customize settings, where {ns} is the camel-cased version of the plugin's package name.{pkgName}) to the {dataDir}/config/.plugins file, listing one package per line.To disable a plugin, remove it from the .plugins file or comment it out using a # and restart the application.
# .plugins file
bajo-config
bajo-extra
bajo-templateBajo automatically scans for hook files during the boot process. To create a handler for a hook, place a file in the {appDir}/main/extend/bajo/hook directory.
Because colons (:) are not allowed in filenames, Bajo replaces the colon in the hook name with an @ symbol. For example, a hook named main:sayHello must be defined in a file named main@sayHello.js.
// File: {appDir}/main/extend/bajo/hook/main@sayHello.js
async function sayHello (...params) {
const [mainChar, friend, payload] = params;
console.log(mainChar, friend, payload);
}
export default sayHello;Bajo is a pure ES6 framework that relies heavily on dynamic imports. It has the following runtime constraints: