https://github.com/alt-javascript/boot
An opinionated application config and logging bootstrap that streamlines the use of the @alt-javascript/config, and @alt-javascript/logger.
https://github.com/alt-javascript/boot
Last synced: 2 months ago
JSON representation
An opinionated application config and logging bootstrap that streamlines the use of the @alt-javascript/config, and @alt-javascript/logger.
- Host: GitHub
- URL: https://github.com/alt-javascript/boot
- Owner: alt-javascript
- License: mit
- Created: 2021-07-16T20:29:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-17T01:12:11.000Z (about 3 years ago)
- Last Synced: 2025-03-12T00:38:35.132Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 426 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
An Extensible Config & Logging Application Bootstrap Function
=============================================================
[](https://nodei.co/npm/@alt-javascript/boot/)
[release notes](https://github.com/alt-javascript/boot/blob/main/History.md)
Introduction
--------------------------------
An opinionated application config and logging bootstrap that streamlines the use of the
- [@alt-javascript/config](https://www.npmjs.com/package/@alt-javascript/config),
- [@alt-javascript/logger](https://www.npmjs.com/package/@alt-javascript/logger), and
- [@alt-javascript/cdi](https://www.npmjs.com/package/@alt-javascript/cdi)
The `Application` class implements a familiar application context and dependency injection
(cdi) implementation, supporting simple singleton and prototype component factory definitions, with a choice of
manual or auto wiring (injection) of property references and config placeholders.
The `Application` class extends the standalone `boot` function, which binds a global root context with configured LoggerFactory
to negate the need for requiring and injecting the application config in every module, and optionally the `node-fetch`
implementation for config pulled from a service url.
The `config`, `loggerFactory`, `LoggerCategoryCache` are registered as injectable singleton components, and the `logger`
is an injectable prototype. See the [@alt-javascript/cdi](https://www.npmjs.com/package/@alt-javascript/cdi) package for more
detail on how the dependency injection works.
Usage
-------------------------
The following example bootstraps an Application with an EmphemeraConfig (but could easily be a regular config
or alt-javascript/config instance), with a basic config context component definition.
```javascript
const ephemeralConfig = new EphemeralConfig(
{
context: {
SimpleClass: {
Reference: SimpleClass,
},
},
},
);
const applicationContext = Application.run({ config: ephemeralConfig });
const simpleClass = applicationContext.get('simpleClass');
assert.exists(simpleClass, 'simpleClass exists');
```
To use the module boot function standalone, substitute the named {config} module export, in place of the popular
[config](https://www.npmjs.com/package/config) default, and `boot` it – note, we use a named export for config,
because the module exports other useful classes as well.
```javascript
import {config} from '@alt-javascript/config';
import {LoggerFactory} from '@alt-javascript/logger';
import {boot} from '@alt-javascript/boot';
boot({config});
config.get('key');
config.get('nested.key');
config.get('unknown','use this instead'); // this does not throw an error
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule');
logger.info('Hello World!')
```
To boot and use [winston](https://www.npmjs.com/package/winston) as the logging transport,
boot a WinstonLoggerFactory instead.
`MyApp.js`
```javascript
import {config} from '@alt-javascript/config';
import winston from 'winston';
import {LoggerFactory, WinstonLoggerFactory} from '@alt-javascript/logger';
import {boot} from '@alt-javascript/boot';
const winstonLoggerFactory = new WinstonLoggerFactory(config,winston,{/*my winston options*/})
boot({config:config, loggerFactory:winstonLoggerFactory});
```
Then in your application modules, you only need.
`MyModule.js`
```javascript
import {LoggerFactory} from '@alt-javascript/logger';
// LoggerFactory.getLogger will now bind to the global root context loggerFactory,
// configured with booted winstonLoggerFactory from MyApp.js.
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule');
logger.info('Hello from MyModule!')
```
`MyOtherModule.js`
```javascript
import {LoggerFactory} from '@alt-javascript/logger';
// Shared logging config, different file.
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyOtherModule');
logger.info('Hello from MyOtherModule!')
```
### Browser
The module is also able to be used directly in the browser, in combination with the config module.
You can either import the LoggerFactory globally as an IIFE (Immediately Invoked Function Expression),
as follows:
```html
var config = ConfigFactory.getConfig({
logging : {
format : 'json',
level : {
'/' : 'info',
'/MyPage': 'info'
}
}
"http://127+0+0+1:8080" : {
logging : {
format : 'json',
level : {
'/' : 'info',
'/MyPage' : 'debug'
}
}
}
})
var logger = LoggerFactory.getLogger('/MyPage',config);
logger.debug('Hello World');
```
Or import the ES6 module bundle from a module, as follows:
```javascript
import { boot } from 'https://cdn.jsdelivr.net/npm/@alt-javascript/logger/dist/alt-javascript-config-esm.js'
//...as above
```
License
-----------------------------
May be freely distributed under the [MIT license](https://raw.githubusercontent.com/alt-javascript/boot/main/LICENSE).
Copyright (c) 2021 Craig Parravicini