nightingale-unit-testing 12.1.0

package/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "root": true,
+  "extends": ["@pob/eslint-config/root-commonjs"],
+  "ignorePatterns": ["*.d.ts", "/dist"]
+}

package/AUTHORS

@@ -0,0 +1 @@
+Christophe Hurpeau <christophe@hurpeau.com>

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [12.1.0](https://github.com/christophehurpeau/nightingale/compare/v12.0.1...v12.1.0) (2021-12-15)
+
+
+### Features
+
+* add nightingale-unit-testing ([d5ac010](https://github.com/christophehurpeau/nightingale/commit/d5ac01093d9d7e02cc62f0437f6bb03981853a3d))

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) 2021 Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all
+copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+<h3 align="center">
+  nightingale-unit-testing
+</h3>
+
+<p align="center">
+  nightingale default config for unit testing
+</p>
+
+<p align="center">
+  <a href="https://npmjs.org/package/nightingale-unit-testing"><img src="https://img.shields.io/npm/v/nightingale-unit-testing.svg?style=flat-square"></a>
+</p>
+
+## Install
+
+```sh
+npm install --save-dev nightingale-unit-testing
+```
+
+## Display a library logs
+
+In your source file, use [nightingale-logger](https://www.npmjs.com/package/nightingale-logger).
+
+In `test-setup` for example:
+
+```js
+import 'nightingale-unit-testing';
+```
+
+By default, only log above 'ERROR' are displayed
+
+When running test, use `DEBUG` to show all logs.
+
+Example with jest:
+
+```bash
+DEBUG='my-lib' npm test
+```
+
+You can also use `NIGHTINGALE_LIB_MIN_LEVEL` to change the default level of log (but applies to every libraries). See [nightingale-levels](https://www.npmjs.com/package/nightingale-levels) to know what values can be used.
+
+```bash
+# display all logs above 'INFO'
+NIGHTINGALE_LIB_MIN_LEVEL=200 npm test
+```
+
+You can of course also combine the two
+
+```bash
+# display all logs above 'INFO', unless it's `my-lib` for which all logs are displayed
+NIGHTINGALE_LIB_MIN_LEVEL=200 DEBUG='my-lib' npm test
+```
+
+## Logging in tests
+
+```js
+import { testLogger } from 'nightingale-unit-testing';
+
+it('should test something', () => {
+  const value = 'hello world';
+  testLogger.inspectValue(value);
+  expect(value).toBe('hello world');
+});
+```
+
+By default, only log above 'DEBUG' are displayed in DEV and above 'INFO' in PRODUCTION (`process.env.NODE_ENV === 'production'`)

package/dist/index-node14.cjs.js

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const nightingale = require('nightingale');
+const nightingaleConsole = require('nightingale-console');
+
+const testMinLevel = process.env.NIGHTINGALE_TEST_MIN_LEVEL !== undefined && process.env.NIGHTINGALE_TEST_MIN_LEVEL !== '' ? Number(process.env.NIGHTINGALE_TEST_MIN_LEVEL) : process.env.NODE_ENV !== "production" ? nightingale.Level.DEBUG : nightingale.Level.INFO;
+const libMinLevel = process.env.NIGHTINGALE_LIB_MIN_LEVEL !== undefined && process.env.NIGHTINGALE_LIB_MIN_LEVEL !== '' ? Number(process.env.NIGHTINGALE_LIB_MIN_LEVEL) : nightingale.Level.INFO;
+const testLogger = new nightingale.Logger('unit-testing');
+nightingale.configure([{
+  pattern: /^app(:|$)/,
+  handlers: [new nightingaleConsole.ConsoleHandler(testMinLevel)],
+  stop: true
+}, {
+  handlers: [new nightingaleConsole.ConsoleHandler(libMinLevel)]
+}]);
+
+exports.Level = nightingale.Level;
+exports.Logger = nightingale.Logger;
+exports.addConfig = nightingale.addConfig;
+exports.configure = nightingale.configure;
+exports.levels = nightingale.levels;
+exports.testLogger = testLogger;
+//# sourceMappingURL=index-node14.cjs.js.map

package/dist/index-node14.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-node14.cjs.js","sources":["../src/index.ts"],"sourcesContent":["import { configure, Level, Logger } from 'nightingale';\nimport { ConsoleHandler } from 'nightingale-console';\n\nexport { configure, addConfig, levels, Level, Logger } from 'nightingale';\n\nconst testMinLevel =\n  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== undefined &&\n  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== ''\n    ? Number(process.env.NIGHTINGALE_TEST_MIN_LEVEL)\n    : __DEV__\n    ? Level.DEBUG\n    : Level.INFO;\n\nconst libMinLevel =\n  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== undefined &&\n  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== ''\n    ? Number(process.env.NIGHTINGALE_LIB_MIN_LEVEL)\n    : Level.INFO;\n\nexport const testLogger = new Logger('unit-testing');\n\nconfigure([\n  {\n    pattern: /^app(:|$)/,\n    handlers: [new ConsoleHandler(testMinLevel)],\n    stop: true,\n  },\n  {\n    handlers: [new ConsoleHandler(libMinLevel)],\n  },\n]);\n"],"names":["testMinLevel","process","env","NIGHTINGALE_TEST_MIN_LEVEL","undefined","Number","__DEV__","Level","DEBUG","INFO","libMinLevel","NIGHTINGALE_LIB_MIN_LEVEL","testLogger","Logger","configure","pattern","handlers","ConsoleHandler","stop"],"mappings":";;;;;;;AAKA,MAAMA,YAAY,GAChBC,OAAO,CAACC,GAAR,CAAYC,0BAAZ,KAA2CC,SAA3C,IACAH,OAAO,CAACC,GAAR,CAAYC,0BAAZ,KAA2C,EAD3C,GAEIE,MAAM,CAACJ,OAAO,CAACC,GAAR,CAAYC,0BAAb,CAFV,GAGIG,qCAAO,GACPC,iBAAK,CAACC,KADC,GAEPD,iBAAK,CAACE,IANZ;AAQA,MAAMC,WAAW,GACfT,OAAO,CAACC,GAAR,CAAYS,yBAAZ,KAA0CP,SAA1C,IACAH,OAAO,CAACC,GAAR,CAAYS,yBAAZ,KAA0C,EAD1C,GAEIN,MAAM,CAACJ,OAAO,CAACC,GAAR,CAAYS,yBAAb,CAFV,GAGIJ,iBAAK,CAACE,IAJZ;MAMaG,UAAU,GAAG,IAAIC,kBAAJ,CAAW,cAAX;AAE1BC,qBAAS,CAAC,CACR;AACEC,EAAAA,OAAO,EAAE,WADX;AAEEC,EAAAA,QAAQ,EAAE,CAAC,IAAIC,iCAAJ,CAAmBjB,YAAnB,CAAD,CAFZ;AAGEkB,EAAAA,IAAI,EAAE;AAHR,CADQ,EAMR;AACEF,EAAAA,QAAQ,EAAE,CAAC,IAAIC,iCAAJ,CAAmBP,WAAnB,CAAD;AADZ,CANQ,CAAD,CAAT;;;;;;;;;"}

package/dist/index-node14.mjs

@@ -0,0 +1,17 @@
+import { Level, Logger, configure } from 'nightingale';
+export { Level, Logger, addConfig, configure, levels } from 'nightingale';
+import { ConsoleHandler } from 'nightingale-console';
+
+const testMinLevel = process.env.NIGHTINGALE_TEST_MIN_LEVEL !== undefined && process.env.NIGHTINGALE_TEST_MIN_LEVEL !== '' ? Number(process.env.NIGHTINGALE_TEST_MIN_LEVEL) : process.env.NODE_ENV !== "production" ? Level.DEBUG : Level.INFO;
+const libMinLevel = process.env.NIGHTINGALE_LIB_MIN_LEVEL !== undefined && process.env.NIGHTINGALE_LIB_MIN_LEVEL !== '' ? Number(process.env.NIGHTINGALE_LIB_MIN_LEVEL) : Level.INFO;
+const testLogger = new Logger('unit-testing');
+configure([{
+  pattern: /^app(:|$)/,
+  handlers: [new ConsoleHandler(testMinLevel)],
+  stop: true
+}, {
+  handlers: [new ConsoleHandler(libMinLevel)]
+}]);
+
+export { testLogger };
+//# sourceMappingURL=index-node14.mjs.map

package/dist/index-node14.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-node14.mjs","sources":["../src/index.ts"],"sourcesContent":["import { configure, Level, Logger } from 'nightingale';\nimport { ConsoleHandler } from 'nightingale-console';\n\nexport { configure, addConfig, levels, Level, Logger } from 'nightingale';\n\nconst testMinLevel =\n  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== undefined &&\n  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== ''\n    ? Number(process.env.NIGHTINGALE_TEST_MIN_LEVEL)\n    : __DEV__\n    ? Level.DEBUG\n    : Level.INFO;\n\nconst libMinLevel =\n  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== undefined &&\n  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== ''\n    ? Number(process.env.NIGHTINGALE_LIB_MIN_LEVEL)\n    : Level.INFO;\n\nexport const testLogger = new Logger('unit-testing');\n\nconfigure([\n  {\n    pattern: /^app(:|$)/,\n    handlers: [new ConsoleHandler(testMinLevel)],\n    stop: true,\n  },\n  {\n    handlers: [new ConsoleHandler(libMinLevel)],\n  },\n]);\n"],"names":["testMinLevel","process","env","NIGHTINGALE_TEST_MIN_LEVEL","undefined","Number","__DEV__","Level","DEBUG","INFO","libMinLevel","NIGHTINGALE_LIB_MIN_LEVEL","testLogger","Logger","configure","pattern","handlers","ConsoleHandler","stop"],"mappings":";;;;AAKA,MAAMA,YAAY,GAChBC,OAAO,CAACC,GAAR,CAAYC,0BAAZ,KAA2CC,SAA3C,IACAH,OAAO,CAACC,GAAR,CAAYC,0BAAZ,KAA2C,EAD3C,GAEIE,MAAM,CAACJ,OAAO,CAACC,GAAR,CAAYC,0BAAb,CAFV,GAGIG,qCAAO,GACPC,KAAK,CAACC,KADC,GAEPD,KAAK,CAACE,IANZ;AAQA,MAAMC,WAAW,GACfT,OAAO,CAACC,GAAR,CAAYS,yBAAZ,KAA0CP,SAA1C,IACAH,OAAO,CAACC,GAAR,CAAYS,yBAAZ,KAA0C,EAD1C,GAEIN,MAAM,CAACJ,OAAO,CAACC,GAAR,CAAYS,yBAAb,CAFV,GAGIJ,KAAK,CAACE,IAJZ;MAMaG,UAAU,GAAG,IAAIC,MAAJ,CAAW,cAAX;AAE1BC,SAAS,CAAC,CACR;AACEC,EAAAA,OAAO,EAAE,WADX;AAEEC,EAAAA,QAAQ,EAAE,CAAC,IAAIC,cAAJ,CAAmBjB,YAAnB,CAAD,CAFZ;AAGEkB,EAAAA,IAAI,EAAE;AAHR,CADQ,EAMR;AACEF,EAAAA,QAAQ,EAAE,CAAC,IAAIC,cAAJ,CAAmBP,WAAnB,CAAD;AADZ,CANQ,CAAD,CAAT;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { Logger } from 'nightingale';
+export { configure, addConfig, levels, Level, Logger } from 'nightingale';
+export declare const testLogger: Logger;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,MAAM,EAAE,MAAM,aAAa,CAAC;AAGvD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAgB1E,eAAO,MAAM,UAAU,QAA6B,CAAC"}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "nightingale-unit-testing",
+  "version": "12.1.0",
+  "description": "nightingale default config for unit testing",
+  "keywords": [],
+  "author": "Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/christophehurpeau/nightingale.git",
+    "directory": "packages/nightingale-unit-testing"
+  },
+  "homepage": "https://github.com/christophehurpeau/nightingale",
+  "type": "commonjs",
+  "engines": {
+    "node": "^14.13.1 || >=16.0.0"
+  },
+  "main": "./dist/index-node14.cjs.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "node": {
+        "import": "./dist/index-node14.mjs",
+        "require": "./dist/index-node14.cjs.js"
+      }
+    }
+  },
+  "module:node": "./dist/index-node14.mjs",
+  "sideEffects": false,
+  "scripts": {
+    "build": "pob-build && yarn run build:definitions",
+    "build:definitions": "tsc -p tsconfig.build.json",
+    "clean": "rm -Rf dist",
+    "lint": "yarn run lint:eslint",
+    "lint:eslint": "cd ../.. && yarn run eslint --report-unused-disable-directives --resolve-plugins-relative-to . --quiet packages/nightingale-unit-testing",
+    "watch": "pob-watch"
+  },
+  "prettier": {
+    "trailingComma": "all",
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
+  "pob": {
+    "babelEnvs": [
+      {
+        "target": "node",
+        "version": "14",
+        "formats": [
+          "cjs",
+          "es"
+        ]
+      }
+    ],
+    "entries": [
+      "index"
+    ]
+  },
+  "dependencies": {
+    "@types/node": ">=14.0.0",
+    "nightingale": "12.1.0",
+    "nightingale-console": "12.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.16.0",
+    "pob-babel": "29.4.2",
+    "typescript": "4.5.4"
+  },
+  "gitHead": "f2f75856d32f444f0ed08b5ab903537cb1f4c38f"
+}

package/rollup.config.mjs

@@ -0,0 +1,3 @@
+import createRollupConfig from 'pob-babel/createRollupConfig.js';
+
+export default createRollupConfig({});

package/src/.eslintrc.json

@@ -0,0 +1,30 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "packages/nightingale-unit-testing/tsconfig.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "@pob/eslint-config-typescript",
+    "@pob/eslint-config-typescript/node"
+  ],
+  "ignorePatterns": ["*.d.ts"],
+  "overrides": [
+    {
+      "files": ["**/*.test.ts", "__tests__/**/*.ts"],
+      "extends": ["@pob/eslint-config-typescript/test"],
+      "env": {
+        "jest": true
+      },
+      "rules": {
+        "import/no-extraneous-dependencies": [
+          "error",
+          {
+            "devDependencies": true
+          }
+        ]
+      }
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,31 @@
+import { configure, Level, Logger } from 'nightingale';
+import { ConsoleHandler } from 'nightingale-console';
+
+export { configure, addConfig, levels, Level, Logger } from 'nightingale';
+
+const testMinLevel =
+  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== undefined &&
+  process.env.NIGHTINGALE_TEST_MIN_LEVEL !== ''
+    ? Number(process.env.NIGHTINGALE_TEST_MIN_LEVEL)
+    : __DEV__
+    ? Level.DEBUG
+    : Level.INFO;
+
+const libMinLevel =
+  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== undefined &&
+  process.env.NIGHTINGALE_LIB_MIN_LEVEL !== ''
+    ? Number(process.env.NIGHTINGALE_LIB_MIN_LEVEL)
+    : Level.INFO;
+
+export const testLogger = new Logger('unit-testing');
+
+configure([
+  {
+    pattern: /^app(:|$)/,
+    handlers: [new ConsoleHandler(testMinLevel)],
+    stop: true,
+  },
+  {
+    handlers: [new ConsoleHandler(libMinLevel)],
+  },
+]);