Merge pull request #4 from webdeveric/feat/options

Allow `style` option to be an array

Author: webdeveric

.github/workflows/ci.yml

@@ -31,12 +31,12 @@ jobs:
       - name: Installing dependencies
         run: pnpm install --frozen-lockfile
 
-      - name: Linting
-        run: pnpm lint
-
       - name: Type checking
         run: pnpm typecheck
 
+      - name: Linting
+        run: pnpm lint
+
       - name: Testing
         run: pnpm coverage
 

example/index.ts

@@ -2,6 +2,7 @@ import { randomInt } from 'node:crypto';
 import { styleText } from 'node:util';
 
 import { createConsole } from 'styled-json-console';
+import { mergeStyleOptions } from 'styled-json-console/mergeStyleOptions';
 
 const myConsole = createConsole({
   inspectOptions: {
@@ -37,9 +38,9 @@ const myConsole = createConsole({
     // stderr settings are merged with stdout settings so you can override only what you want
     {
       space: 2,
-      style: {
-        string: ['white', 'whiteBright'],
-      },
+      style: mergeStyleOptions(['whiteBright'], {
+        number: ['magentaBright'],
+      }),
     },
   ],
 });
@@ -50,6 +51,7 @@ const data = {
   randomNumber: randomInt(0, 2 ** 32 - 1),
   example: true,
   json: JSON.stringify({ a: 1, b: [2], c: { d: 3, e: [4, 5] } }),
+  nested: { a: 1, b: [2], c: { d: 3, e: [4, 5] } },
 };
 
 myConsole.info(JSON.stringify(data));

package.json

@@ -48,11 +48,11 @@
   "homepage": "https://github.com/webdeveric/styled-json-console/#readme",
   "packageManager": "pnpm@10.26.2+sha512.0e308ff2005fc7410366f154f625f6631ab2b16b1d2e70238444dd6ae9d630a8482d92a451144debc492416896ed16f7b114a86ec68b8404b2443869e68ffda6",
   "scripts": {
-    "clean": "rimraf ./dist/",
+    "clean": "rimraf ./dist/ ./cache/",
     "prebuild": "pnpm clean",
     "build": "tsc --build tsconfig.src.json --force",
-    "typecheck": "tsc --build tsconfig.src.json tsconfig.test.json tsconfig.configs.json --verbose",
-    "lint": "eslint ./*.{js,cjs,mjs,ts,cts,mts} ./src/ --ext .ts",
+    "typecheck": "tsc --build tsconfig.json --verbose",
+    "lint": "eslint ./*.{js,cjs,mjs,ts,cts,mts} ./src/ ./example/ --ext .ts",
     "test": "vitest --typecheck",
     "coverage": "vitest run --coverage --typecheck",
     "validate": "validate-package-exports --check --verify",

src/AnsiJsonWritable.ts

@@ -2,9 +2,9 @@ import { Writable, type WritableOptions } from 'node:stream';
 
 import { ansiHighlightJson } from './ansiHighlightJson.js';
 import { isColorEnabled } from './isColorEnabled.js';
-import { Style, type StyleOptions } from './Style.js';
+import { Style } from './Style.js';
 
-import type { JsonReplacerFn } from './types.js';
+import type { JsonReplacerFn, StyleOptions, StyleTextFormatArray } from './types.js';
 
 export type ModifyOutputFn = (output: string, style: Style) => string;
 
@@ -13,7 +13,7 @@ export type AnsiJsonWritableOptions = WritableOptions & {
   space?: number | string;
   eol?: string;
   replacer?: JsonReplacerFn;
-  styleOptions?: Partial<StyleOptions>;
+  styleOptions?: Partial<StyleOptions> | StyleTextFormatArray;
   modifyOutput?: ModifyOutputFn;
 };
 

src/Style.ts

@@ -1,57 +1,23 @@
 import { styleText, type StyleTextOptions } from 'node:util';
 
-import type { StyleTextFormat } from './types.js';
-
-export type StyleKeys =
-  | 'string'
-  | 'number'
-  | 'boolean'
-  | 'bracket'
-  | 'comma'
-  | 'colon'
-  | 'quoteKey'
-  | 'quoteString'
-  | 'key'
-  | 'null';
+import { defaultStyleOptions } from './defaults.js';
+import { mergeStyleOptions } from './mergeStyleOptions.js';
+
+import type { StyleKey, StyleOptions, StyleTextFormat, StyleTextFormatArray } from './types.js';
 
 export type StyleFn = (value: string, depth: number) => string;
 
 export type BaseStyle = {
-  [K in StyleKeys]: StyleFn;
-};
-
-export type StyleOptions = Record<
-  StyleKeys,
-  [item: StyleTextFormat, ...rest: StyleTextFormat[]] // At least one item
->;
-
-export const defaultStyleOptions: StyleOptions = {
-  // content
-  string: ['green'],
-  number: ['yellowBright'],
-  boolean: ['blueBright'],
-  null: ['redBright'],
-
-  // structural
-  bracket: ['white', 'blue', 'yellow', 'cyan', 'green', 'red'],
-  comma: ['white'],
-  colon: ['white'],
-
-  // quotes
-  quoteKey: ['cyan'],
-  quoteString: ['green'],
-
-  // keys
-  key: ['cyan'],
+  [K in StyleKey]: StyleFn;
 };
 
 export class Style implements BaseStyle {
   readonly #options: StyleOptions;
 
   readonly #styleTextOptions: StyleTextOptions = { validateStream: false };
 
-  constructor(options?: Partial<StyleOptions>) {
-    this.#options = { ...defaultStyleOptions, ...options };
+  constructor(options?: Partial<StyleOptions> | StyleTextFormatArray) {
+    this.#options = mergeStyleOptions(defaultStyleOptions, options);
   }
 
   #getStyleTextFormat(type: keyof StyleOptions, depth: number): StyleTextFormat {

src/createConsole.ts

@@ -1,12 +1,12 @@
 import { Console, type ConsoleConstructorOptions } from 'node:console';
 
 import { AnsiJsonWritable, type ModifyOutputFn } from './AnsiJsonWritable.js';
+import { mergeStyleOptions } from './mergeStyleOptions.js';
 
-import type { StyleOptions } from './Style.js';
-import type { JsonReplacerFn } from './types.js';
+import type { JsonReplacerFn, StyleOptions, StyleTextFormatArray } from './types.js';
 
 export type JsonConsoleOptions = {
-  style?: Partial<StyleOptions>;
+  style?: Partial<StyleOptions> | StyleTextFormatArray;
   space?: number | string;
   replacer?: JsonReplacerFn;
 };
@@ -28,10 +28,7 @@ export function createConsole(options: Partial<CreateConsoleOptions> = {}): Cons
     ? {
         ...stdOutJson,
         ...json[1],
-        style: {
-          ...stdOutJson?.style,
-          ...json[1]?.style,
-        },
+        style: mergeStyleOptions(stdOutJson?.style, json[1]?.style),
       }
     : json;
 

src/createSimpleStyleOptions.test.ts

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'vitest';
+
+import { createSimpleStyleOptions } from './createSimpleStyleOptions.js';
+
+import type { StyleOptions } from './types.js';
+
+describe('createSimpleStyleOptions', () => {
+  it('creates style options with the given value for all style keys', () => {
+    expect(createSimpleStyleOptions(['red'])).toEqual({
+      boolean: ['red'],
+      bracket: ['red'],
+      colon: ['red'],
+      comma: ['red'],
+      key: ['red'],
+      null: ['red'],
+      number: ['red'],
+      quoteKey: ['red'],
+      quoteString: ['red'],
+      string: ['red'],
+    } satisfies StyleOptions);
+  });
+});

src/createSimpleStyleOptions.ts

@@ -0,0 +1,16 @@
+import { defaultStyleOptions } from './defaults.js';
+import { isStyleKey } from './isStyleKey.js';
+
+import type { StyleOptions, StyleTextFormatArray } from './types.js';
+
+export function createSimpleStyleOptions(value: StyleTextFormatArray): StyleOptions {
+  const options: StyleOptions = { ...defaultStyleOptions };
+
+  for (const key in options) {
+    if (isStyleKey(key)) {
+      options[key] = value;
+    }
+  }
+
+  return options;
+}

src/defaults.ts

@@ -0,0 +1,21 @@
+import type { StyleOptions } from './types.js';
+
+export const defaultStyleOptions: Readonly<StyleOptions> = {
+  // content
+  string: ['green'],
+  number: ['yellowBright'],
+  boolean: ['blueBright'],
+  null: ['redBright'],
+
+  // structural
+  bracket: ['white', 'blue', 'yellow', 'cyan', 'green', 'red'],
+  comma: ['white'],
+  colon: ['white'],
+
+  // quotes
+  quoteKey: ['cyan'],
+  quoteString: ['green'],
+
+  // keys
+  key: ['cyan'],
+};

src/isStyleKey.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, it } from 'vitest';
+
+import { isStyleKey } from './isStyleKey.js';
+
+describe('isStyleKey()', () => {
+  it.each(['string', 'number', 'boolean', 'bracket', 'comma', 'colon', 'quoteKey', 'quoteString', 'key', 'null'])(
+    'returns true for %j',
+    (input) => {
+      expect(isStyleKey(input)).toBe(true);
+    },
+  );
+
+  it.each([null, undefined, 42, {}, [], 'not valid'])('returns false for %j', (input) => {
+    expect(isStyleKey(input)).toBe(false);
+  });
+});