obj-console - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

dist/index.d.ts

@@ -1,4 +0,4 @@
-import { FormatOptions } from './options';
-export * from './options';
-export * from './color-scheme';
+import { FormatOptions } from "./options";
+export { AS_JSON, BRIEF, COLUMNS, COMPACT, ONE_LINE, FormatOptions, defaults } from "./options";
+export { colorScheme, cylceColor } from "./color-scheme";
 /** Prints object to terminal with colors and custom format */
@@ -5,0 +5,0 @@ export declare function objConsole(data: any, opts?: FormatOptions): void;

dist/index.js

 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -20,3 +6,3 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objFormat = exports.objStdout = exports.objConsole = void 0;
+exports.objFormat = exports.objStdout = exports.objConsole = exports.cylceColor = exports.colorScheme = exports.defaults = exports.ONE_LINE = exports.COMPACT = exports.COLUMNS = exports.BRIEF = exports.AS_JSON = void 0;
 const paint_1 = __importDefault(require("./paint"));
@@ -26,4 +12,12 @@ const options_1 = require("./options");
 const color_scheme_1 = require("./color-scheme");
-__exportStar(require("./options"), exports);
-__exportStar(require("./color-scheme"), exports);
+var options_2 = require("./options");
+Object.defineProperty(exports, "AS_JSON", { enumerable: true, get: function () { return options_2.AS_JSON; } });
+Object.defineProperty(exports, "BRIEF", { enumerable: true, get: function () { return options_2.BRIEF; } });
+Object.defineProperty(exports, "COLUMNS", { enumerable: true, get: function () { return options_2.COLUMNS; } });
+Object.defineProperty(exports, "COMPACT", { enumerable: true, get: function () { return options_2.COMPACT; } });
+Object.defineProperty(exports, "ONE_LINE", { enumerable: true, get: function () { return options_2.ONE_LINE; } });
+Object.defineProperty(exports, "defaults", { enumerable: true, get: function () { return options_2.defaults; } });
+var color_scheme_2 = require("./color-scheme");
+Object.defineProperty(exports, "colorScheme", { enumerable: true, get: function () { return color_scheme_2.colorScheme; } });
+Object.defineProperty(exports, "cylceColor", { enumerable: true, get: function () { return color_scheme_2.cylceColor; } });
 /** Prints object to terminal with colors and custom format */
@@ -38,3 +32,3 @@ function objConsole(data, opts) {
 function objStdout(data, opts) {
-    process.stdout.write(objFormat(data, opts) + '\n');
+    process.stdout.write(objFormat(data, opts) + "\n");
 }
@@ -53,4 +47,4 @@ exports.objStdout = objStdout;
     const bracketsColor = (0, color_scheme_1.cylceColor)(depth);
-    let eol = isLine ? '' : "\n";
-    let bracketsPadd = '';
+    let eol = isLine ? "" : "\n";
+    let bracketsPadd = "";
     for (let i = depth; i; i--)
@@ -60,4 +54,4 @@ bracketsPadd += padding;
         bracketsPadd = "";
-    const valPadd = isLine ? '' : bracketsPadd + padding;
-    const eolComma = (eol && omitEolCommas) ? '' : ', ';
+    const valPadd = isLine ? "" : bracketsPadd + padding;
+    const eolComma = eol && omitEolCommas ? "" : ", ";
     // -- Arrays ----
@@ -71,4 +65,4 @@ if (Array.isArray(data)) {
                 s += paint_1.default.gray(eolComma);
-            if (maxArrayLength && (i > maxArrayLength - 2)) {
-                s += eol + valPadd + '... overall ' + data.length + ' elements' + eol;
+            if (maxArrayLength && i > maxArrayLength - 2) {
+                s += eol + valPadd + "... overall " + data.length + " elements" + eol;
                 break;
@@ -112,3 +106,3 @@ }
 function isScalar(data) {
-    return data === null || typeof data !== 'object';
+    return data === null || typeof data !== "object";
 }

package.json

 {
   "name": "obj-console",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Shows JS objects in terminal with custom format in VSCode colors",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -5,2 +5,4 @@ # obj-console
 
+You can tune output to enhance readability of single objects or arrays. Or print compact brief of data just to understand, that data has appropriate form. For example, options: `{unfoldDepth: 1, omitBrackets: true, omitEolCommas: true, quote: "", align: true}` leads to output:
+
 ![columns-object](https://github.com/m-kant/obj-console/raw/main/docs/columns-object.png)
@@ -25,3 +27,3 @@
 ```typescript
-export interface FormatOptions {
+interface FormatOptions {
   omitBrackets?: boolean;
@@ -28,0 +30,0 @@ /** Ommit commas at the end of lines even in arrays */

src/index.ts

 import paint from "./paint";
-import { FormatOptions, defaults } from './options';
-import { formatScalar } from './format-scalar';
-import { cylceColor } from './color-scheme';
+import { FormatOptions, defaults } from "./options";
+import { formatScalar } from "./format-scalar";
+import { cylceColor } from "./color-scheme";
 
-export * from './options';
-export * from './color-scheme';
+export { AS_JSON, BRIEF, COLUMNS, COMPACT, ONE_LINE, FormatOptions, defaults } from "./options";
+export { colorScheme, cylceColor } from "./color-scheme";
 
@@ -17,3 +17,3 @@ /** Prints object to terminal with colors and custom format */
 export function objStdout(data: any, opts?: FormatOptions) {
-  process.stdout.write(objFormat(data, opts) + '\n');
+  process.stdout.write(objFormat(data, opts) + "\n");
 }
@@ -26,6 +26,3 @@
   // -- prepare ----
-  const {
-    padding, maxDepth, align, maxArrayLength, keyQuote, unfoldDepth,
-    omitEolCommas, omitBrackets
-  } = localOpts;
+  const { padding, maxDepth, align, maxArrayLength, keyQuote, unfoldDepth, omitEolCommas, omitBrackets } = localOpts;
   if (depth > maxDepth) return paint.hex("BF360C", "...too deep", !depth);
@@ -35,9 +32,9 @@
   const bracketsColor = cylceColor(depth);
-  let eol = isLine ? '' : "\n";
+  let eol = isLine ? "" : "\n";
 
-  let bracketsPadd = '';
+  let bracketsPadd = "";
   for (let i = depth; i; i--) bracketsPadd += padding;
   if (isLine) bracketsPadd = "";
-  const valPadd = isLine ? '' : bracketsPadd + padding;
-  const eolComma = (eol && omitEolCommas) ? '' : ', ';
+  const valPadd = isLine ? "" : bracketsPadd + padding;
+  const eolComma = eol && omitEolCommas ? "" : ", ";
 
@@ -51,4 +48,4 @@ // -- Arrays ----
       if (i < data.length - 1) s += paint.gray(eolComma);
-      if (maxArrayLength && (i > maxArrayLength - 2)) {
-        s += eol + valPadd +'... overall ' + data.length + ' elements' + eol;
+      if (maxArrayLength && i > maxArrayLength - 2) {
+        s += eol + valPadd + "... overall " + data.length + " elements" + eol;
         break;
@@ -70,3 +67,3 @@ }
       const v = data[k];
-      s += valPadd + paint.key( keyQuote + k + keyQuote);
+      s += valPadd + paint.key(keyQuote + k + keyQuote);
       s += paint.gray(": ".padEnd(keyMaxLen - k.length + 2));
@@ -77,3 +74,3 @@ s += objFormat(v, opts, depth + 1);
     }
-    if (!omitBrackets) s +=  bracketsPadd + paint.hex(bracketsColor, "}");
+    if (!omitBrackets) s += bracketsPadd + paint.hex(bracketsColor, "}");
     return s;
@@ -93,3 +90,3 @@ }
 function isScalar(data: any) {
-  return data === null || typeof data !== 'object'
+  return data === null || typeof data !== "object";
 }

TODO.md

@@ -0,5 +1,6 @@
+
+- `colors: false` option
 - 'strange key': "val'w'quote", 'one"more': 'with"dbl" quote', "anohter's": 'curio\'s'
-- remove brackets
 - custom formatter()
 - is it possible to make alignment to any depth??
 - is it possible to make alignment for array of objects

No alert changes

Improved metrics

Total package byte prevSize

72709

1.17%

Number of lines in readme file

67

3.08%

Worsened metrics

Lines of code

673

-1.32%

No dependency changes