Skip to content

Commit

Permalink
feat: rename to log-node
Browse files Browse the repository at this point in the history
Additionally adapt to log4 -> log rename
  • Loading branch information
medikoo committed Nov 29, 2018
1 parent f9bb274 commit e4209d9
Show file tree
Hide file tree
Showing 10 changed files with 43 additions and 43 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
![Transpilation status][transpilation-image]
[![npm version][npm-image]][npm-url]

# log4-nodejs
# log-node

## [log4](https://github.com/medikoo/log4/) log writer for typical [Node.js](https://nodejs.org/) processes
## [log](https://github.com/medikoo/log/) log writer for typical [Node.js](https://nodejs.org/) processes

- [Printf-like message formatting](https://github.com/medikoo/log4#output-message-formatting)
- Configure log level visbility threshold through [`LOG_LEVEL`](https://github.com/medikoo/log4#log_level) env variable (defaults to `notice`)
- Extra debug output can be controlled via [`LOG_DEBUG`](https://github.com/medikoo/log4#log_debug) env variable (fallbacks to `DEBUG` if provided)
- [Printf-like message formatting](https://github.com/medikoo/log#output-message-formatting)
- Configure log level visbility threshold through [`LOG_LEVEL`](https://github.com/medikoo/log#log_level) env variable (defaults to `notice`)
- Extra debug output can be controlled via [`LOG_DEBUG`](https://github.com/medikoo/log#log_debug) env variable (fallbacks to `DEBUG` if provided)
- Outputs colored logs if terminal supports it (can overriden through `DEBUG_COLORS` env variable)
- Object inspection depth defaults to `4`, but can be overriden via `LOG_INSPECT_DEPTH` (fallbacks to `DEBUG_DEPTH` if provided)
- Writes to `stderr` stream.
Expand All @@ -20,19 +20,19 @@
At beginning of main module of your program invoke:

```javascript
require("log4-nodejs")();
require("log-node")();
```

### Tests

$ npm test

[nix-build-image]: https://semaphoreci.com/api/v1/medikoo-org/log4-nodejs/branches/master/shields_badge.svg
[nix-build-url]: https://semaphoreci.com/medikoo-org/log4-nodejs
[nix-build-image]: https://semaphoreci.com/api/v1/medikoo-org/log-node/branches/master/shields_badge.svg
[nix-build-url]: https://semaphoreci.com/medikoo-org/log-node
[win-build-image]: https://ci.appveyor.com/api/projects/status/tqetc30h571osc2n?svg=true
[win-build-url]: https://ci.appveyor.com/project/medikoo/log4-nodejs
[cov-image]: https://img.shields.io/codecov/c/github/medikoo/log4-nodejs.svg
[cov-url]: https://codecov.io/gh/medikoo/log4-nodejs
[win-build-url]: https://ci.appveyor.com/project/medikoo/log-node
[cov-image]: https://img.shields.io/codecov/c/github/medikoo/log-node.svg
[cov-url]: https://codecov.io/gh/medikoo/log-node
[transpilation-image]: https://img.shields.io/badge/transpilation-free-brightgreen.svg
[npm-image]: https://img.shields.io/npm/v/log4-nodejs.svg
[npm-url]: https://www.npmjs.com/package/log4-nodejs
[npm-image]: https://img.shields.io/npm/v/log-node.svg
[npm-url]: https://www.npmjs.com/package/log-node
12 changes: 6 additions & 6 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
const isObject = require("es5-ext/object/is-object")
, d = require("d")
, clc = require("cli-color/bare")
, rootLogger = require("log4")
, emitter = require("log4/writer-utils/emitter")
, registerMaster = require("log4/writer-utils/register-master")
, setupVisibility = require("log4/writer-utils/setup-visibility")
, setDefaultNamespace = require("log4/writer-utils/get-default-namespace").set
, rootLogger = require("log")
, emitter = require("log/writer-utils/emitter")
, registerMaster = require("log/writer-utils/register-master")
, setupVisibility = require("log/writer-utils/setup-visibility")
, setDefaultNamespace = require("log/writer-utils/get-default-namespace").set
, colorsSupportLevel = require("./lib/colors-support-level")
, formatMessage = require("./utils/format-event-message")
, levelPrefixes = require("./utils/level-prefixes")
Expand All @@ -33,7 +33,7 @@ const setupPrefixes = levelLogger => {
module.exports = (options = {}) => {
if (!isObject(options)) options = {};

// Ensure it's the only log4 writer initialzed in a process
// Ensure it's the only log writer initialzed in a process
registerMaster();

if (options.defaultNamespace) setDefaultNamespace(options.defaultNamespace);
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"name": "log4-nodejs",
"name": "log-node",
"version": "3.1.1",
"description": "Node.js log generator for log4 engine",
"description": "Node.js log generator for log engine",
"author": "Mariusz Nowak <medyk@medikoo.com> (http://www.medikoo.com/)",
"keywords": [
"log",
"log4",
"log",
"logger",
"debug",
"bunyan",
"winston"
],
"repository": {
"type": "git",
"url": "https://github.com/medikoo/log4-node.git"
"url": "https://github.com/medikoo/log-node.git"
},
"dependencies": {
"cli-color": "^1.3",
Expand All @@ -29,13 +29,13 @@
"eslint": "^5.6",
"eslint-config-medikoo": "^1.43",
"istanbul": "^0.4.5",
"log4": "^3.1",
"log": "^3.1",
"process-utils": "2",
"tape": "^4.9.1",
"tape-index": "2"
},
"peerDependencies": {
"log4": "^3.1"
"log": "^3.1"
},
"eslintConfig": {
"extends": "medikoo",
Expand Down
10 changes: 5 additions & 5 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ const resolveUncached = callback => {
try {
return requireUncached(
[
require.resolve("log4"), require.resolve("log4/writer-utils/emitter"),
require.resolve("log4/writer-utils/register-master"),
require.resolve("log4/writer-utils/setup-visibility"),
require.resolve("log"), require.resolve("log/writer-utils/emitter"),
require.resolve("log/writer-utils/register-master"),
require.resolve("log/writer-utils/setup-visibility"),
require.resolve("supports-color"), require.resolve("../lib/colors-support-level"),
require.resolve("../utils/format-event-message"),
require.resolve("../utils/resolve-format-parts"), require.resolve("../")
],
() => {
callback();
return { log: require("log4"), initializeWriter: require("../") };
return { log: require("log"), initializeWriter: require("../") };
}
);
} finally {
restoreEnv();
}
};

test("log4-nodejs", t => {
test("log-nodejs", t => {
t.test(t => {
const { log, initializeWriter } = resolveUncached(
() => (require("supports-color").stderr = false)
Expand Down
4 changes: 2 additions & 2 deletions test/utils/format-event-message.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const resolveUncached = callback => {
try {
return requireUncached(
[
require.resolve("log4/writer-utils/emitter"), require.resolve("log4"),
require.resolve("log/writer-utils/emitter"), require.resolve("log"),
require.resolve("../../utils/resolve-format-parts"),
require.resolve("../../utils/format-event-message"),
require.resolve("supports-color"),
Expand All @@ -20,7 +20,7 @@ const resolveUncached = callback => {
() => {
callback();
return {
logger: require("log4"),
logger: require("log"),
formatMessage: require("../../utils/format-event-message")
};
}
Expand Down
4 changes: 2 additions & 2 deletions test/utils/format.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const resolveUncached = callback => {
try {
return requireUncached(
[
require.resolve("log4/writer-utils/emitter"), require.resolve("log4"),
require.resolve("log/writer-utils/emitter"), require.resolve("log"),
require.resolve("../../utils/resolve-format-parts"),
require.resolve("../../utils/format-event-message"),
require.resolve("supports-color"),
Expand All @@ -20,7 +20,7 @@ const resolveUncached = callback => {
() => {
callback();
return {
logger: require("log4"),
logger: require("log"),
formatMessage: require("../../utils/format-event-message")
};
}
Expand Down
10 changes: 5 additions & 5 deletions test/utils/get-namespace-prefix.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ const resolveUncached = callback => {
try {
return requireUncached(
[
require.resolve("log4"), require.resolve("log4/writer-utils/emitter"),
require.resolve("log4/writer-utils/get-default-namespace"),
require.resolve("log"), require.resolve("log/writer-utils/emitter"),
require.resolve("log/writer-utils/get-default-namespace"),
require.resolve("../../utils/get-namespace-prefix"),
require.resolve("supports-color"), require.resolve("../../lib/colors-support-level")
],
() => {
callback();
return {
log: require("log4"),
log: require("log"),
getNamespacePrefix: require("../../utils/get-namespace-prefix")
};
}
Expand Down Expand Up @@ -77,7 +77,7 @@ test("getNamespacePrefix", t => {
t.test("Should not show default namespace", t => {
const { log, getNamespacePrefix } = resolveUncached(() => {
require("supports-color").stderr = false;
require("log4/writer-utils/get-default-namespace").set("marko");
require("log/writer-utils/get-default-namespace").set("marko");
});

t.equal(getNamespacePrefix(log.get("foo")), log.get("foo").namespace);
Expand All @@ -93,7 +93,7 @@ test("getNamespacePrefix", t => {
require("supports-color").stderr = false;
process.env.DEBUG_COLORS = "on";
return {
log: require("log4"),
log: require("log"),
getNamespacePrefix: require("../../utils/get-namespace-prefix")
};
});
Expand Down
2 changes: 1 addition & 1 deletion test/utils/resolve-format-parts.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const resolveUncached = callback => {
try {
return requireUncached(
[
require.resolve("log4/writer-utils/emitter"), require.resolve("log4"),
require.resolve("log/writer-utils/emitter"), require.resolve("log"),
require.resolve("../../utils/resolve-format-parts"),
require.resolve("supports-color"),
require.resolve("../../lib/colors-support-level"),
Expand Down
2 changes: 1 addition & 1 deletion utils/get-namespace-prefix.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"use strict";

const getDefaultNamespace = require("log4/writer-utils/get-default-namespace")
const getDefaultNamespace = require("log/writer-utils/get-default-namespace")
, colorsSupportLevel = require("../lib/colors-support-level");

const resolveNamespaceString = logger => {
Expand Down
4 changes: 2 additions & 2 deletions utils/level-prefixes.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const entries = require("es5-ext/object/entries")
, clc = require("cli-color/bare")
, defaultSymbols = require("log4/writer-utils/level-symbols")
, defaultSymbols = require("log/writer-utils/level-symbols")
, colorsSupportLevel = require("../lib/colors-support-level");

const symbols = (() => {
Expand All @@ -23,7 +23,7 @@ if (!colorsSupportLevel) {
module.exports = symbols;
return;
}
const coloredSymbols = module.exports = {};
const coloredSymbols = (module.exports = {});
for (const [levelName, colorDecorator] of entries({
debug: clc.blackBright,
info: clc.blueBright,
Expand Down

0 comments on commit e4209d9

Please sign in to comment.