From e4209d92b6715d7597b0114b03b4af7c530ae162 Mon Sep 17 00:00:00 2001 From: Mariusz Nowak Date: Thu, 29 Nov 2018 10:12:43 +0100 Subject: [PATCH] feat: rename to log-node Additionally adapt to log4 -> log rename --- README.md | 26 +++++++++++++------------- index.js | 12 ++++++------ package.json | 12 ++++++------ test/index.js | 10 +++++----- test/utils/format-event-message.js | 4 ++-- test/utils/format.js | 4 ++-- test/utils/get-namespace-prefix.js | 10 +++++----- test/utils/resolve-format-parts.js | 2 +- utils/get-namespace-prefix.js | 2 +- utils/level-prefixes.js | 4 ++-- 10 files changed, 43 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 26ac4f8..adb9126 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/index.js b/index.js index 213ae53..0b68bd9 100644 --- a/index.js +++ b/index.js @@ -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") @@ -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); diff --git a/package.json b/package.json index b3ec497..099d3fa 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ { - "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 (http://www.medikoo.com/)", "keywords": [ "log", - "log4", + "log", "logger", "debug", "bunyan", @@ -13,7 +13,7 @@ ], "repository": { "type": "git", - "url": "https://github.com/medikoo/log4-node.git" + "url": "https://github.com/medikoo/log-node.git" }, "dependencies": { "cli-color": "^1.3", @@ -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", diff --git a/test/index.js b/test/index.js index 11fb0bd..015c449 100644 --- a/test/index.js +++ b/test/index.js @@ -9,16 +9,16 @@ 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 { @@ -26,7 +26,7 @@ const resolveUncached = callback => { } }; -test("log4-nodejs", t => { +test("log-nodejs", t => { t.test(t => { const { log, initializeWriter } = resolveUncached( () => (require("supports-color").stderr = false) diff --git a/test/utils/format-event-message.js b/test/utils/format-event-message.js index bfc7a49..c3d9e3b 100644 --- a/test/utils/format-event-message.js +++ b/test/utils/format-event-message.js @@ -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"), @@ -20,7 +20,7 @@ const resolveUncached = callback => { () => { callback(); return { - logger: require("log4"), + logger: require("log"), formatMessage: require("../../utils/format-event-message") }; } diff --git a/test/utils/format.js b/test/utils/format.js index bfc7a49..c3d9e3b 100644 --- a/test/utils/format.js +++ b/test/utils/format.js @@ -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"), @@ -20,7 +20,7 @@ const resolveUncached = callback => { () => { callback(); return { - logger: require("log4"), + logger: require("log"), formatMessage: require("../../utils/format-event-message") }; } diff --git a/test/utils/get-namespace-prefix.js b/test/utils/get-namespace-prefix.js index 99d030a..7709f00 100644 --- a/test/utils/get-namespace-prefix.js +++ b/test/utils/get-namespace-prefix.js @@ -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") }; } @@ -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); @@ -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") }; }); diff --git a/test/utils/resolve-format-parts.js b/test/utils/resolve-format-parts.js index 186d6b5..ea05a53 100644 --- a/test/utils/resolve-format-parts.js +++ b/test/utils/resolve-format-parts.js @@ -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"), diff --git a/utils/get-namespace-prefix.js b/utils/get-namespace-prefix.js index 4f1f3db..c5ca7cb 100644 --- a/utils/get-namespace-prefix.js +++ b/utils/get-namespace-prefix.js @@ -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 => { diff --git a/utils/level-prefixes.js b/utils/level-prefixes.js index 0d361b5..546ea65 100644 --- a/utils/level-prefixes.js +++ b/utils/level-prefixes.js @@ -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 = (() => { @@ -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,