nightingale-browser-console-formatter 15.0.0 → 16.1.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [16.1.0](https://github.com/christophehurpeau/nightingale/compare/v16.0.0...v16.1.0) (2025-03-30)
+
+Version bump for dependency: nightingale
+
+
+## [16.0.0](https://github.com/christophehurpeau/nightingale/compare/v15.0.0...v16.0.0) (2025-03-30)
+
+### ⚠ BREAKING CHANGES
+
+* drop node 18
+
+### Features
+
+* drop node 18 ([1b11a55](https://github.com/christophehurpeau/nightingale/commit/1b11a55dd24c9435be50519a748316079f554414))
+
+### Bug Fixes
+
+* fix lib exports ([5b562b2](https://github.com/christophehurpeau/nightingale/commit/5b562b245aac1aa86b728a9433f3c9d28c62fe04))
+
+Version bump for dependency: nightingale
+
+
 ## [15.0.0](https://github.com/christophehurpeau/nightingale/compare/v14.2.1...v15.0.0) (2023-12-25)
 
 

package/README.md

@@ -1,27 +1,30 @@
-<h3 align="center">
+<h1 align="center">
   nightingale-browser-console-formatter
-</h3>
+</h1>
 
 <p align="center">
-  Nightingale Browser console formatter
+  Deprecated: use NightingaleBrowserConsoleFormatter from nightingale
 </p>
 
 <p align="center">
-  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/v/nightingale-browser-console-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/dw/nightingale-browser-console-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/node/v/nightingale-browser-console-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/types/nightingale-browser-console-formatter.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/v/nightingale-browser-console-formatter.svg?style=flat-square" alt="npm version"></a>
+  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/dw/nightingale-browser-console-formatter.svg?style=flat-square" alt="npm downloads"></a>
+  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/node/v/nightingale-browser-console-formatter.svg?style=flat-square" alt="node version"></a>
+  <a href="https://npmjs.org/package/nightingale-browser-console-formatter"><img src="https://img.shields.io/npm/types/nightingale-browser-console-formatter.svg?style=flat-square" alt="types"></a>
   <a href="https://codecov.io/gh/christophehurpeau/nightingale"><img src="https://img.shields.io/codecov/c/github/christophehurpeau/nightingale/master.svg?style=flat-square"></a>
 </p>
 
 ## Install
 
 ```sh
-npm install --save nightingale-browser-console-formatter
+npm install --save nightingale
 ```
 
 ## Usage
 
 ```js
-import browserConsoleFormatter from 'nightingale-browser-console-formatter';
+import { NightingaleBrowserConsoleFormatter } from "nightingale";
+
+const formatter = new NightingaleBrowserConsoleFormatter("light");
+formatter.format(record);
 ```

package/lib/index.js

@@ -0,0 +1,12 @@
+import { BrowserConsoleFormatter } from "nightingale";
+
+/**
+ *
+ * param is dark or light
+ * @param {"light" | "dark"} [theme="light"]
+ * @returns {import("nightingale").StringArrayNightingaleFormatter["format"]}
+ */
+export default function createBrowserConsoleFormatter(theme = "light") {
+  const formatter = new BrowserConsoleFormatter(theme);
+  return (record) => formatter.format(record);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nightingale-browser-console-formatter",
-  "version": "15.0.0",
-  "description": "Nightingale Browser console formatter",
+  "version": "16.1.0",
+  "description": "Deprecated: use NightingaleBrowserConsoleFormatter from nightingale",
   "keywords": [
     "nightingale",
     "nightingale-formatter"
@@ -16,72 +16,28 @@
   "homepage": "https://github.com/christophehurpeau/nightingale",
   "type": "module",
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.9.0"
   },
-  "browserslist": {
-    "production": [
-      "defaults",
-      "> 0.2%",
-      "not ie < 12",
-      "not safari < 10",
-      "not ios_saf < 10"
-    ]
-  },
-  "main": "./dist/index-node18.mjs",
-  "types": "./dist/definitions/index.d.ts",
-  "module": "./dist/index-browser.es.js",
-  "browser": "./dist/index-browser.es.js",
+  "sideEffects": false,
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/definitions/index.d.ts",
-      "node": {
-        "import": "./dist/index-node18.mjs"
-      },
-      "browser": {
-        "import": "./dist/index-browser.es.js"
-      }
-    }
+    ".": "./lib/index.js"
   },
-  "sideEffects": false,
   "files": [
-    "src",
-    "dist"
+    "lib"
   ],
   "scripts": {
-    "build": "yarn clean:build && rollup --config rollup.config.mjs && yarn run build:definitions",
-    "build:definitions": "tsc -p tsconfig.json",
     "clean": "yarn clean:build",
-    "clean:build": "pob-babel-clean-out dist",
     "lint": "yarn run lint:eslint",
-    "lint:eslint": "yarn ../.. run eslint --report-unused-disable-directives --resolve-plugins-relative-to . --quiet packages/nightingale-browser-console-formatter",
+    "lint:eslint": "yarn ../.. run eslint --quiet packages/nightingale-browser-console-formatter",
     "test": "yarn ../../ run test -- packages/nightingale-browser-console-formatter",
     "watch": "yarn clean:build && rollup --config rollup.config.mjs --watch"
   },
+  "pob": {},
   "prettier": "@pob/root/prettier-config",
-  "pob": {
-    "babelEnvs": [
-      {
-        "target": "node",
-        "version": "18"
-      },
-      {
-        "target": "browser"
-      }
-    ],
-    "entries": [
-      "index"
-    ]
-  },
   "dependencies": {
-    "nightingale-formatter": "15.0.0",
-    "nightingale-types": "15.0.0"
-  },
-  "devDependencies": {
-    "@babel/core": "7.23.6",
-    "@babel/preset-env": "7.23.6",
-    "nightingale-levels": "15.0.0",
-    "pob-babel": "38.0.0",
-    "typescript": "5.3.3"
+    "nightingale": "16.1.0"
   }
 }

package/dist/definitions/index.d.ts

@@ -1,5 +0,0 @@
-import type { StyleToHtmlStyle } from 'nightingale-formatter';
-import type { LogRecord, Metadata, Styles } from 'nightingale-types';
-export declare const style: (styleToHtmlStyle: StyleToHtmlStyle, args: string[]) => (styles: Styles, string: string) => string;
-export declare function createBrowserConsoleFormatter(theme?: 'dark' | 'light'): <T extends Metadata>(record: LogRecord<T>) => string[];
-//# sourceMappingURL=index.d.ts.map

package/dist/definitions/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAM9D,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAErE,eAAO,MAAM,KAAK,qBACG,gBAAgB,QAAQ,MAAM,EAAE,cAC1C,MAAM,UAAU,MAAM,KAAG,MAWjC,CAAC;AAEJ,wBAAgB,6BAA6B,CAC3C,KAAK,GAAE,MAAM,GAAG,OAAiB,GAChC,CAAC,CAAC,SAAS,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAQxD"}

package/dist/definitions/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/definitions/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index-browser.es.js

@@ -1,21 +0,0 @@
-import { formatRecordToString, styleToHtmlStyleThemeDark, styleToHtmlStyleThemeLight } from 'nightingale-formatter';
-
-const style = (styleToHtmlStyle, args) => (styles, string) => {
-  if (!styles || styles.length === 0 || !string) {
-    return string;
-  }
-  const htmlStyles = styles.map(styleName => styleToHtmlStyle[styleName]);
-  args.push(htmlStyles.map(s => s.open).join('; '), htmlStyles.map(s => s.close).join('; '));
-  return `%c${string}%c`;
-};
-function createBrowserConsoleFormatter(theme = 'light') {
-  const styleToHtmlStyle = theme === 'dark' ? styleToHtmlStyleThemeDark : styleToHtmlStyleThemeLight;
-  return function format(record) {
-    const args = [];
-    const string = formatRecordToString(record, style(styleToHtmlStyle, args));
-    return [string, ...args];
-  };
-}
-
-export { createBrowserConsoleFormatter, style };
-//# sourceMappingURL=index-browser.es.js.map

package/dist/index-browser.es.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-browser.es.js","sources":["../src/index.ts"],"sourcesContent":["import type { StyleToHtmlStyle } from 'nightingale-formatter';\nimport {\n  formatRecordToString,\n  styleToHtmlStyleThemeLight,\n  styleToHtmlStyleThemeDark,\n} from 'nightingale-formatter';\nimport type { LogRecord, Metadata, Styles } from 'nightingale-types';\n\nexport const style =\n  (styleToHtmlStyle: StyleToHtmlStyle, args: string[]) =>\n  (styles: Styles, string: string): string => {\n    if (!styles || styles.length === 0 || !string) {\n      return string;\n    }\n\n    const htmlStyles = styles.map((styleName) => styleToHtmlStyle[styleName]);\n    args.push(\n      htmlStyles.map((s) => s.open).join('; '),\n      htmlStyles.map((s) => s.close).join('; '),\n    );\n    return `%c${string}%c`;\n  };\n\nexport function createBrowserConsoleFormatter(\n  theme: 'dark' | 'light' = 'light',\n): <T extends Metadata>(record: LogRecord<T>) => string[] {\n  const styleToHtmlStyle: StyleToHtmlStyle =\n    theme === 'dark' ? styleToHtmlStyleThemeDark : styleToHtmlStyleThemeLight;\n  return function format<T extends Metadata>(record: LogRecord<T>): string[] {\n    const args: string[] = [];\n    const string = formatRecordToString(record, style(styleToHtmlStyle, args));\n    return [string, ...args];\n  };\n}\n"],"names":["style","styleToHtmlStyle","args","styles","string","length","htmlStyles","map","styleName","push","s","open","join","close","createBrowserConsoleFormatter","theme","styleToHtmlStyleThemeDark","styleToHtmlStyleThemeLight","format","record","formatRecordToString"],"mappings":";;AAQaA,MAAAA,KAAK,GAChBA,CAACC,gBAAkC,EAAEC,IAAc,KACnD,CAACC,MAAc,EAAEC,MAAc,KAAa;EAC1C,IAAI,CAACD,MAAM,IAAIA,MAAM,CAACE,MAAM,KAAK,CAAC,IAAI,CAACD,MAAM,EAAE;AAC7C,IAAA,OAAOA,MAAM,CAAA;AACf,GAAA;AAEA,EAAA,MAAME,UAAU,GAAGH,MAAM,CAACI,GAAG,CAAEC,SAAS,IAAKP,gBAAgB,CAACO,SAAS,CAAC,CAAC,CAAA;AACzEN,EAAAA,IAAI,CAACO,IAAI,CACPH,UAAU,CAACC,GAAG,CAAEG,CAAC,IAAKA,CAAC,CAACC,IAAI,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC,EACxCN,UAAU,CAACC,GAAG,CAAEG,CAAC,IAAKA,CAAC,CAACG,KAAK,CAAC,CAACD,IAAI,CAAC,IAAI,CAC1C,CAAC,CAAA;EACD,OAAQ,CAAA,EAAA,EAAIR,MAAO,CAAG,EAAA,CAAA,CAAA;AACxB,EAAC;AAEI,SAASU,6BAA6BA,CAC3CC,KAAuB,GAAG,OAAO,EACuB;EACxD,MAAMd,gBAAkC,GACtCc,KAAK,KAAK,MAAM,GAAGC,yBAAyB,GAAGC,0BAA0B,CAAA;AAC3E,EAAA,OAAO,SAASC,MAAMA,CAAqBC,MAAoB,EAAY;IACzE,MAAMjB,IAAc,GAAG,EAAE,CAAA;AACzB,IAAA,MAAME,MAAM,GAAGgB,oBAAoB,CAACD,MAAM,EAAEnB,KAAK,CAACC,gBAAgB,EAAEC,IAAI,CAAC,CAAC,CAAA;AAC1E,IAAA,OAAO,CAACE,MAAM,EAAE,GAAGF,IAAI,CAAC,CAAA;GACzB,CAAA;AACH;;;;"}

package/dist/index-node18.mjs

@@ -1,21 +0,0 @@
-import { formatRecordToString, styleToHtmlStyleThemeDark, styleToHtmlStyleThemeLight } from 'nightingale-formatter';
-
-const style = (styleToHtmlStyle, args) => (styles, string) => {
-  if (!styles || styles.length === 0 || !string) {
-    return string;
-  }
-  const htmlStyles = styles.map(styleName => styleToHtmlStyle[styleName]);
-  args.push(htmlStyles.map(s => s.open).join('; '), htmlStyles.map(s => s.close).join('; '));
-  return `%c${string}%c`;
-};
-function createBrowserConsoleFormatter(theme = 'light') {
-  const styleToHtmlStyle = theme === 'dark' ? styleToHtmlStyleThemeDark : styleToHtmlStyleThemeLight;
-  return function format(record) {
-    const args = [];
-    const string = formatRecordToString(record, style(styleToHtmlStyle, args));
-    return [string, ...args];
-  };
-}
-
-export { createBrowserConsoleFormatter, style };
-//# sourceMappingURL=index-node18.mjs.map

package/dist/index-node18.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-node18.mjs","sources":["../src/index.ts"],"sourcesContent":["import type { StyleToHtmlStyle } from 'nightingale-formatter';\nimport {\n  formatRecordToString,\n  styleToHtmlStyleThemeLight,\n  styleToHtmlStyleThemeDark,\n} from 'nightingale-formatter';\nimport type { LogRecord, Metadata, Styles } from 'nightingale-types';\n\nexport const style =\n  (styleToHtmlStyle: StyleToHtmlStyle, args: string[]) =>\n  (styles: Styles, string: string): string => {\n    if (!styles || styles.length === 0 || !string) {\n      return string;\n    }\n\n    const htmlStyles = styles.map((styleName) => styleToHtmlStyle[styleName]);\n    args.push(\n      htmlStyles.map((s) => s.open).join('; '),\n      htmlStyles.map((s) => s.close).join('; '),\n    );\n    return `%c${string}%c`;\n  };\n\nexport function createBrowserConsoleFormatter(\n  theme: 'dark' | 'light' = 'light',\n): <T extends Metadata>(record: LogRecord<T>) => string[] {\n  const styleToHtmlStyle: StyleToHtmlStyle =\n    theme === 'dark' ? styleToHtmlStyleThemeDark : styleToHtmlStyleThemeLight;\n  return function format<T extends Metadata>(record: LogRecord<T>): string[] {\n    const args: string[] = [];\n    const string = formatRecordToString(record, style(styleToHtmlStyle, args));\n    return [string, ...args];\n  };\n}\n"],"names":["style","styleToHtmlStyle","args","styles","string","length","htmlStyles","map","styleName","push","s","open","join","close","createBrowserConsoleFormatter","theme","styleToHtmlStyleThemeDark","styleToHtmlStyleThemeLight","format","record","formatRecordToString"],"mappings":";;AAQaA,MAAAA,KAAK,GAChBA,CAACC,gBAAkC,EAAEC,IAAc,KACnD,CAACC,MAAc,EAAEC,MAAc,KAAa;EAC1C,IAAI,CAACD,MAAM,IAAIA,MAAM,CAACE,MAAM,KAAK,CAAC,IAAI,CAACD,MAAM,EAAE;AAC7C,IAAA,OAAOA,MAAM,CAAA;AACf,GAAA;AAEA,EAAA,MAAME,UAAU,GAAGH,MAAM,CAACI,GAAG,CAAEC,SAAS,IAAKP,gBAAgB,CAACO,SAAS,CAAC,CAAC,CAAA;AACzEN,EAAAA,IAAI,CAACO,IAAI,CACPH,UAAU,CAACC,GAAG,CAAEG,CAAC,IAAKA,CAAC,CAACC,IAAI,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC,EACxCN,UAAU,CAACC,GAAG,CAAEG,CAAC,IAAKA,CAAC,CAACG,KAAK,CAAC,CAACD,IAAI,CAAC,IAAI,CAC1C,CAAC,CAAA;EACD,OAAQ,CAAA,EAAA,EAAIR,MAAO,CAAG,EAAA,CAAA,CAAA;AACxB,EAAC;AAEI,SAASU,6BAA6BA,CAC3CC,KAAuB,GAAG,OAAO,EACuB;EACxD,MAAMd,gBAAkC,GACtCc,KAAK,KAAK,MAAM,GAAGC,yBAAyB,GAAGC,0BAA0B,CAAA;AAC3E,EAAA,OAAO,SAASC,MAAMA,CAAqBC,MAAoB,EAAY;IACzE,MAAMjB,IAAc,GAAG,EAAE,CAAA;AACzB,IAAA,MAAME,MAAM,GAAGgB,oBAAoB,CAACD,MAAM,EAAEnB,KAAK,CAACC,gBAAgB,EAAEC,IAAI,CAAC,CAAC,CAAA;AAC1E,IAAA,OAAO,CAACE,MAAM,EAAE,GAAGF,IAAI,CAAC,CAAA;GACzB,CAAA;AACH;;;;"}

package/src/.eslintrc.json

@@ -1,27 +0,0 @@
-{
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "packages/nightingale-browser-console-formatter/tsconfig.json"
-  },
-  "plugins": ["@typescript-eslint"],
-  "extends": ["@pob/eslint-config-typescript"],
-  "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.test.ts

@@ -1,59 +0,0 @@
-import type { StyleToHtmlStyle } from 'nightingale-formatter';
-import { styleToHtmlStyleThemeLight } from 'nightingale-formatter';
-import { Level } from 'nightingale-levels';
-import { createBrowserConsoleFormatter, style } from '.';
-
-const styleToHtmlStyle: StyleToHtmlStyle = styleToHtmlStyleThemeLight;
-const formatWithLightTheme = createBrowserConsoleFormatter('light');
-const formatWithDarkTheme = createBrowserConsoleFormatter('dark');
-
-test('style: blue bold color', () => {
-  const args: string[] = [];
-  expect(style(styleToHtmlStyle, args)(['blue', 'bold'], 'test')).toBe(
-    '%ctest%c',
-  );
-  expect(args).toEqual([
-    'color: #00a0ff; font-weight: bold',
-    'color: currentcolor; font-weight: normal',
-  ]);
-});
-
-test('format simple message, with light theme', () => {
-  const record = {
-    key: 'record.key',
-    level: Level.INFO,
-    datetime: new Date(2000, 1, 1, 1, 0, 0),
-    message: 'test',
-    metadata: {},
-    extra: {},
-  };
-
-  const [string, ...args] = formatWithLightTheme(record);
-  expect(string).toBe('%crecord.key%c %c01:00:00%c → test');
-  expect(args).toEqual([
-    'color: #808080',
-    'color: currentcolor',
-    'color: gray; font-weight: bold',
-    'color: currentcolor; font-weight: normal',
-  ]);
-});
-
-test('format simple message, with dark theme', () => {
-  const record = {
-    key: 'record.key',
-    level: Level.INFO,
-    datetime: new Date(2000, 1, 1, 1, 0, 0),
-    message: 'test',
-    metadata: {},
-    extra: {},
-  };
-
-  const [string, ...args] = formatWithDarkTheme(record);
-  expect(string).toBe('%crecord.key%c %c01:00:00%c → test');
-  expect(args).toEqual([
-    'color: #808080',
-    'color: currentcolor',
-    'color: lightgray; font-weight: bold',
-    'color: currentcolor; font-weight: normal',
-  ]);
-});

package/src/index.ts

@@ -1,34 +0,0 @@
-import type { StyleToHtmlStyle } from 'nightingale-formatter';
-import {
-  formatRecordToString,
-  styleToHtmlStyleThemeLight,
-  styleToHtmlStyleThemeDark,
-} from 'nightingale-formatter';
-import type { LogRecord, Metadata, Styles } from 'nightingale-types';
-
-export const style =
-  (styleToHtmlStyle: StyleToHtmlStyle, args: string[]) =>
-  (styles: Styles, string: string): string => {
-    if (!styles || styles.length === 0 || !string) {
-      return string;
-    }
-
-    const htmlStyles = styles.map((styleName) => styleToHtmlStyle[styleName]);
-    args.push(
-      htmlStyles.map((s) => s.open).join('; '),
-      htmlStyles.map((s) => s.close).join('; '),
-    );
-    return `%c${string}%c`;
-  };
-
-export function createBrowserConsoleFormatter(
-  theme: 'dark' | 'light' = 'light',
-): <T extends Metadata>(record: LogRecord<T>) => string[] {
-  const styleToHtmlStyle: StyleToHtmlStyle =
-    theme === 'dark' ? styleToHtmlStyleThemeDark : styleToHtmlStyleThemeLight;
-  return function format<T extends Metadata>(record: LogRecord<T>): string[] {
-    const args: string[] = [];
-    const string = formatRecordToString(record, style(styleToHtmlStyle, args));
-    return [string, ...args];
-  };
-}