Skip to content

Commit 37c080a

Browse files
author
craigparra
committed
1.0.8 / 2021-07-14
================== * Doh, config must be injected (figures) - @craigparra
1 parent bfa0319 commit 37c080a

File tree

7 files changed

+36
-18
lines changed

7 files changed

+36
-18
lines changed

ConfigurableLogger.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ const CONFIG = require('config');
22
const DelegatingLogger = require('./DelegatingLogger');
33

44
module.exports = class ConfigurableLogger extends DelegatingLogger {
5-
constructor(provider, category, configPath, registry, config) {
5+
constructor(config, provider, category, configPath, registry) {
66
super(provider);
7-
this.config = config || CONFIG;
7+
this.config = config;
88
this.category = category;
99
this.configPath = configPath;
1010
this.registry = registry;

History.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
1.0.8 / 2021-07-14
2+
==================
3+
4+
* Doh, config must be injected (figures) - @craigparra
5+
16
1.0.7 / 2021-07-14
27
==================
38

@@ -14,7 +19,7 @@
1419
* Fixed usage example to use ConsoleLogger - @craigparra
1520
* Added slf4j keyword - @craigparra
1621

17-
``1.0.4 / 2021-07-12
22+
1.0.4 / 2021-07-12
1823
==================
1924

2025
* Fixed JSON outputs to proper keyval pairs, plus category output - @craigparra

LoggerFactory.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ const LoggerRegistry = require('./LoggerRegistry');
55
module.exports = class LoggerFactory {
66
static loggerRegistry = new LoggerRegistry();
77

8-
static getLogger(category, provider, configPath, registry) {
9-
return new ConfigurableLogger(
8+
static getLogger(config, category, provider, configPath, registry) {
9+
return new ConfigurableLogger(config,
1010
provider || new ConsoleLogger(category),
1111
category,
1212
configPath,

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ To use the module, import the LoggerFactory and call the `getLogger` function wi
1919
requires path is a sensible choice).
2020

2121
```javascript
22+
const {config} = require('config');
2223
const {LoggerFactory} = require('@alt-javascript/logger');
23-
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule');
24+
const logger = LoggerFactory.getLogger(config,'@myorg/mypackage/MyModule');
2425

2526
logger.info('Hello world!');
2627
```
@@ -76,8 +77,9 @@ function, passing it your winston options (nullish options will fall back to def
7677
7778

7879
```javascript
80+
const {config} = require('config');
7981
const {LoggerFactory,WinstonLogger} = require('@alt-javascript/logger');
80-
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule', new WinstonLogger({/*mywinstonoptions*/}));
82+
const logger = LoggerFactory.getLogger(config,'@myorg/mypackage/MyModule', new WinstonLogger({/*mywinstonoptions*/}));
8183

8284
logger.info('Hello world!');
8385
```
@@ -98,9 +100,10 @@ logger.info('Hello world!');
98100
Testing loggers is hard, and testability is a first class concern at @alt-javascript so the module exports an EphemeralLogger and EphemeralLogSink that will capture log lines that can be asserted.
99101

100102
```javascript
103+
const {config} = require('config');
101104
const {LoggerFactory,EphemeralLogger} = require('@alt-javascript/logger');
102105
const ephemeralLogger = new EphemeralLogger('@myorg/mypackage/MyModule');
103-
const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule', ephemeralLogger);
106+
const logger = LoggerFactory.getLogger(config,'@myorg/mypackage/MyModule', ephemeralLogger);
104107

105108
logger.info('Hello world!');
106109

package.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22
"name": "@alt-javascript/logger",
33
"version": "1.0.6",
44
"description": "A simple configurable logging facade for javascript.",
5-
"author" : "Craig Parravicini",
6-
"keywords": ["log","logger","loglevel", "loggerlevel","LogFactory","facade","config","configurable","slf4j"],
5+
"author": "",
6+
"keywords": [
7+
"log",
8+
"logger",
9+
"loglevel",
10+
"loggerlevel",
11+
"LogFactory",
12+
"facade",
13+
"config",
14+
"configurable",
15+
"slf4j"
16+
],
717
"publishConfig": {
818
"registry": "https://registry.npmjs.org/"
919
},
@@ -22,7 +32,6 @@
2232
"mocha": "mocha --require test/fixtures",
2333
"nyc": "nyc --reporter=json-summary --reporter=text-summary --reporter=lcov npm run test"
2434
},
25-
"author": "",
2635
"license": "MIT",
2736
"dependencies": {
2837
"config": "^3.3.6",

test/console_spec.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
const { assert } = require('chai');
22
const LoggerFactory = require('../LoggerFactory');
33
const LoggerLevel = require('../LoggerLevel');
4-
5-
const logger = LoggerFactory.getLogger('@alt-javascript/logger/test/console_spec');
6-
const defaultLogger = LoggerFactory.getLogger();
4+
const config = require('config');
5+
const logger = LoggerFactory.getLogger(config,'@alt-javascript/logger/test/console_spec');
6+
const defaultLogger = LoggerFactory.getLogger(config);
77
defaultLogger.registry.add('logging.level./', LoggerLevel.DEBUG);
8-
const altDefaultLogger = LoggerFactory.getLogger();
8+
const altDefaultLogger = LoggerFactory.getLogger(config);
99

10-
const verbose = LoggerFactory.getLogger('@alt-javascript/logger/test/console_spec/verbose');
10+
const verbose = LoggerFactory.getLogger(config,'@alt-javascript/logger/test/console_spec/verbose');
1111

1212
assert.isFalse(logger.isVerboseEnabled(), 'Verbose is false');
1313
logger.setLevel(null);

test/winston_spec.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
const config = require('config');
12
const { assert } = require('chai');
23
const LoggerFactory = require('../LoggerFactory');
34
const LoggerLevel = require('../LoggerLevel');
45
const WinstonLogger = require('../WinstonLogger');
56

6-
const logger = LoggerFactory.getLogger('@alt-javascript/logger/test/winston_spec', new WinstonLogger('@alt-javascript/logger/test/winston_spec'));
7-
const verbose = LoggerFactory.getLogger('@alt-javascript/logger/test/winston_spec/verbose', new WinstonLogger('@alt-javascript/logger/test/winston_spec/verbose'));
7+
const logger = LoggerFactory.getLogger(config,'@alt-javascript/logger/test/winston_spec', new WinstonLogger('@alt-javascript/logger/test/winston_spec'));
8+
const verbose = LoggerFactory.getLogger(config,'@alt-javascript/logger/test/winston_spec/verbose', new WinstonLogger('@alt-javascript/logger/test/winston_spec/verbose'));
89

910
assert.isTrue(logger.isVerboseEnabled(), 'Verbose is false');
1011
logger.setLevel(null);

0 commit comments

Comments
 (0)