Skip to content

Commit

Permalink
feat(nightingale-app-console): export ConsoleHandler, fix sideEffect,…
Browse files Browse the repository at this point in the history 
… add env
  • Loading branch information
@christophehurpeau
christophehurpeau committed Jan 31, 2021
1 parent 137b1a7 commit 643c049
Show file tree
Hide file tree
Showing 54 changed files with 274 additions and 130 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

59 changes: 31 additions & 28 deletions ...enums/nightingale_levels_src.default.html → docs/enums/nightingale_levels_src.level.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>default | nightingale-monorepo</title>
<title>Level | nightingale-monorepo</title>
<meta name="description" content="Documentation for nightingale-monorepo">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand Down Expand Up @@ -58,10 +58,10 @@
<a href="../modules/nightingale_levels_src.html">nightingale-levels/src</a>
</li>
<li>
<a href="nightingale_levels_src.default.html">default</a>
<a href="nightingale_levels_src.level.html">Level</a>
</li>
</ul>
<h1>Enumeration default</h1>
<h1>Enumeration Level</h1>
</div>
</div>
</header>
Expand All @@ -75,18 +75,18 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#alert" class="tsd-kind-icon">ALERT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#all" class="tsd-kind-icon">ALL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#critical" class="tsd-kind-icon">CRITICAL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#debug" class="tsd-kind-icon">DEBUG</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#emergency" class="tsd-kind-icon">EMERGENCY</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#error" class="tsd-kind-icon">ERROR</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#fatal" class="tsd-kind-icon">FATAL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#info" class="tsd-kind-icon">INFO</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#notice" class="tsd-kind-icon">NOTICE</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#trace" class="tsd-kind-icon">TRACE</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#warn" class="tsd-kind-icon">WARN</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.default.html#warning" class="tsd-kind-icon">WARNING</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#alert" class="tsd-kind-icon">ALERT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#all" class="tsd-kind-icon">ALL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#critical" class="tsd-kind-icon">CRITICAL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#debug" class="tsd-kind-icon">DEBUG</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#emergency" class="tsd-kind-icon">EMERGENCY</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#error" class="tsd-kind-icon">ERROR</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#fatal" class="tsd-kind-icon">FATAL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#info" class="tsd-kind-icon">INFO</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#notice" class="tsd-kind-icon">NOTICE</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#trace" class="tsd-kind-icon">TRACE</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#warn" class="tsd-kind-icon">WARN</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="nightingale_levels_src.level.html#warning" class="tsd-kind-icon">WARNING</a></li>
</ul>
</section>
</div>
Expand Down Expand Up @@ -290,46 +290,49 @@ <h3>WARNING</h3>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/nightingale_levels_src.html#default" class="tsd-kind-icon">default</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-enum tsd-parent-kind-module">
<a href="nightingale_levels_src.default.html" class="tsd-kind-icon">default</a>
<a href="nightingale_levels_src.level.html" class="tsd-kind-icon">Level</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#alert" class="tsd-kind-icon">ALERT</a>
<a href="nightingale_levels_src.level.html#alert" class="tsd-kind-icon">ALERT</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#all" class="tsd-kind-icon">ALL</a>
<a href="nightingale_levels_src.level.html#all" class="tsd-kind-icon">ALL</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#critical" class="tsd-kind-icon">CRITICAL</a>
<a href="nightingale_levels_src.level.html#critical" class="tsd-kind-icon">CRITICAL</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#debug" class="tsd-kind-icon">DEBUG</a>
<a href="nightingale_levels_src.level.html#debug" class="tsd-kind-icon">DEBUG</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#emergency" class="tsd-kind-icon">EMERGENCY</a>
<a href="nightingale_levels_src.level.html#emergency" class="tsd-kind-icon">EMERGENCY</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#error" class="tsd-kind-icon">ERROR</a>
<a href="nightingale_levels_src.level.html#error" class="tsd-kind-icon">ERROR</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#fatal" class="tsd-kind-icon">FATAL</a>
<a href="nightingale_levels_src.level.html#fatal" class="tsd-kind-icon">FATAL</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#info" class="tsd-kind-icon">INFO</a>
<a href="nightingale_levels_src.level.html#info" class="tsd-kind-icon">INFO</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#notice" class="tsd-kind-icon">NOTICE</a>
<a href="nightingale_levels_src.level.html#notice" class="tsd-kind-icon">NOTICE</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#trace" class="tsd-kind-icon">TRACE</a>
<a href="nightingale_levels_src.level.html#trace" class="tsd-kind-icon">TRACE</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#warn" class="tsd-kind-icon">WARN</a>
<a href="nightingale_levels_src.level.html#warn" class="tsd-kind-icon">WARN</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="nightingale_levels_src.default.html#warning" class="tsd-kind-icon">WARNING</a>
<a href="nightingale_levels_src.level.html#warning" class="tsd-kind-icon">WARNING</a>
</li>
</ul>
</li>
Expand Down
18 changes: 16 additions & 2 deletions docs/modules/nightingale_app_console_src.html
View file
Expand Up @@ -79,6 +79,7 @@ <h3>References</h3>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="nightingale_app_console_src.html#consolehandler" class="tsd-kind-icon">Console<wbr>Handler</a></li>
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="nightingale_app_console_src.html#applogger" class="tsd-kind-icon">app<wbr>Logger</a></li>
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="nightingale_app_console_src.html#logger" class="tsd-kind-icon">logger</a></li>
</ul>
Expand Down Expand Up @@ -108,13 +109,23 @@ <h3>levels</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="consolehandler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Console<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">Console<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">BrowserConsoleHandler</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">TerminalConsoleHandler</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/christophehurpeau/nightingale/blob/master/packages/nightingale-app-console/src/index.ts#L13">nightingale-app-console/src/index.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="applogger" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> app<wbr>Logger</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>Logger<span class="tsd-signature-symbol">:</span> <a href="../classes/nightingale_src.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/christophehurpeau/nightingale/blob/master/packages/nightingale-app-console/src/index.ts#L18">nightingale-app-console/src/index.ts:18</a></li>
<li>Defined in <a href="https://github.com/christophehurpeau/nightingale/blob/master/packages/nightingale-app-console/src/index.ts#L21">nightingale-app-console/src/index.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -124,7 +135,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="../classes/nightingale_src.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/christophehurpeau/nightingale/blob/master/packages/nightingale-app-console/src/index.ts#L17">nightingale-app-console/src/index.ts:17</a></li>
<li>Defined in <a href="https://github.com/christophehurpeau/nightingale/blob/master/packages/nightingale-app-console/src/index.ts#L20">nightingale-app-console/src/index.ts:20</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -201,6 +212,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="nightingale_app_console_src.html#levels" class="tsd-kind-icon">levels</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="nightingale_app_console_src.html#consolehandler" class="tsd-kind-icon">Console<wbr>Handler</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="nightingale_app_console_src.html#applogger" class="tsd-kind-icon">app<wbr>Logger</a>
</li>
Expand Down
21 changes: 19 additions & 2 deletions docs/modules/nightingale_levels_src.html
View file
Expand Up @@ -69,15 +69,29 @@ <h1>Module nightingale-levels/src</h1>
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>References</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="nightingale_levels_src.html#default" class="tsd-kind-icon">default</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/nightingale_levels_src.default.html" class="tsd-kind-icon">default</a></li>
<li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/nightingale_levels_src.level.html" class="tsd-kind-icon">Level</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>References</h2>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
<a name="default" class="tsd-anchor"></a>
<h3>default</h3>
Renames and exports <a href="../enums/nightingale_levels_src.level.html">Level</a>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
Expand All @@ -92,8 +106,11 @@ <h3>Enumerations</h3>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="nightingale_levels_src.html#default" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/nightingale_levels_src.default.html" class="tsd-kind-icon">default</a>
<a href="../enums/nightingale_levels_src.level.html" class="tsd-kind-icon">Level</a>
</li>
</ul>
</nav>
Expand Down
2 changes: 1 addition & 1 deletion packages/nightingale-app-console/.eslintrc.json
View file
@@ -1,5 +1,5 @@
{
"root": true,
"extends": ["@pob/eslint-config/root", "@pob/eslint-config-node"],
"ignorePatterns": ["/dist"]
"ignorePatterns": ["*.d.ts", "/dist"]
}
25 changes: 22 additions & 3 deletions packages/nightingale-app-console/README.md
View file
Expand Up @@ -19,14 +19,33 @@ npm install --save nightingale-app-console
## Usage

```js
import { logger } from 'nightingale-app-console';
import { appLogger } from 'nightingale-app-console';

logger.info('hello');
appLogger.info('hello');
```

## Create children

```js
const myServiceLogger = logger.child('services:myService');
const myServiceLogger = appLogger.child('services:myService');
myServiceLogger.debug('started');
```

## Import the right bundle with webpack

Configure `webpackConfig.resolve.mainFields`:

- node: `env === 'production' ? ['module:node', 'module', 'main'] : ['module:node-dev', 'module:node', 'module-dev', 'module', 'main']`
- browser: `env === 'production' ? ['browser', 'module', 'main'] : ['browser-dev', 'browser', 'module-dev', 'module', 'main']`
- modern browser: `env === 'production' ? ['module:modern-browsers', 'browser', 'module', 'main'] : ['module:modern-browsers-dev','module:modern-browsers', 'browser-dev', 'browser', 'module', 'main']`

## Change default levels

Default level for app (appLogger and children): in production, `Level.INFO` () else `Level.DEBUG`
Default level for lib: `Level.INFO`

You can use `process.env.NIGHTINGALE_APP_MIN_LEVEL` and `process.env.NIGHTINGALE_LIB_MIN_LEVEL` to change theses levels.

```
NIGHTINGALE_APP_MIN_LEVEL=0 node .
```
11 changes: 8 additions & 3 deletions packages/nightingale-app-console/dist/index-browser-dev.cjs.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 643c049

Please sign in to comment.