console-grid - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "console-grid",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "console log a grid",
-  "main": "console-grid.js",
+  "main": "lib/index.js",
   "scripts": {
-    "test": "node test.js"
+    "test": "node test/test.js"
   },
@@ -9,0 +9,0 @@ "repository": {

README.md

 # console-grid
-console log a grid
+console log a grid with tree
 
@@ -12,27 +12,31 @@ ![npm](https://img.shields.io/npm/v/console-grid.svg)
 ```
+# Preview
+```
+┌ ────────────────────────────────────── ┬ ─────── ┬ ──── ┬ ──────────── ┬ ──────────── ┐
+│                                        │         │      │ Number       │ Multiple     │
+│                                        │         │      │ Format red   │ Line Header  │
+│ Name bg green                          │ Value   │ Null │ LongWordL... │ Name         │
+├ ────────────────────────────────────── ┼ ─────── ┼ ──── ┼ ──────────── ┼ ──────────── ┤
+│ |- Row 1                               │ 1       │ -    │ 1.00         │ 1            │
+│ |- Row 2                               │ 2       │ -    │ 2.00         │ 2            │
+│ |- Row Name                            │ 3       │ -    │ 3.00         │ 3            │
+│ |- Row Long Name Red Long Name Long... │ 4       │ -    │ 4.00         │ 4            │
+│ |- Row 5 red                           │ 5       │ -    │ 5.00         │ 5            │
+│ |- Row 6 bg green                      │ 6       │ -    │ 6.00         │ 6            │
+│ |- Row 7 bright blue                   │ 7       │ -    │ 7.00         │ 7            │
+│ |- Row 8 bright bg blue                │ 8       │ -    │ 8.00         │ 8            │
+│    |- Sub Row 1                        │ s1      │ -    │ 11.00        │ s1           │
+│    |- Sub Row 2                        │ s2      │ -    │ 12.00        │ s2           │
+│    |- Sub Row 3                        │ s3 s... │ -    │ 13.00        │ s3 s3 s3     │
+└ ────────────────────────────────────── ┴ ─────── ┴ ──── ┴ ──────────── ┴ ──────────── ┘
+```
 
-
 # Usage
 ```js
 var Grid = require("console-grid");
-
-var option = {
-    columnBorder: " | ",
-    rowBorder: "-",
-    hideHeaders: false,
-    nullPlaceholder: "-",
-    defaultMaxWidth: 30,
-
-    sortField: "",
-    sortAsc: false,
-
-    treeId: "name",
-    treeIcon: "|- ",
-    treeIndent: "   "
-};
-var grid = new Grid(option);
-
-var grid = new Grid(option);
-
+var grid = new Grid();
 var data = {
+    option: {
+        sortField: "name"
+    },
     columns: [{
@@ -42,62 +46,21 @@ id: "name",
         type: "string",
-        maxWidth: 30
+        maxWidth: 38
     }, {
         id: "value",
         name: "Value",
-        type: "string"
-    }, {
-        id: "null",
-        name: "Null"
-    }, {
-        id: "number",
-        type: "number",
-        name: "Number Format",
-        formatter: (v, row, column) => {
-            return Number(v).toFixed(2);
-        }
+        type: "string",
+        maxWidth: 7
     }],
     rows: [{
         name: "Row 1",
-        value: "1",
-        number: 1
+        value: "1"
     }, {
         name: "Row 2",
-        value: "2",
-        number: 2
-    }, {
-        name: "Row Name",
-        value: "3",
-        number: 3
-    }, {
-        name: "Row Long Name Long Name Long Name Long Name" + Grid.style.red("red"),
-        value: "4",
-        number: 4
-    }, {
-        name: "Row 5 " + Grid.style.red("red"),
-        value: "5",
-        number: 5
-    }, {
-        name: "Row 6 " + Grid.style.bg.green("bg green"),
-        value: "6",
-        number: 6
-    }, {
-        name: "Row 7 " + Grid.style.br.blue("bright blue"),
-        value: "7",
-        number: 7
-    }, {
-        name: "Row 8 " + Grid.style.br.bg.blue("bright bg blue"),
-        value: "8",
-        number: 8,
+        value: "2"
         subs: [{
             name: "Sub Row 1",
-            value: "s1",
-            number: 11,
+            value: "s1"
         }, {
             name: "Sub Row 2",
-            value: "s2",
-            number: 12,
-        }, {
-            name: "Sub Row 3",
-            value: "s3",
-            number: 13,
+            value: "s2"
         }]
@@ -108,25 +71,12 @@ }]
 ```
-# Preview
+
+# Default Option
+```js
+console.log(grid.defaultOption());
 ```
------------------------------- | ----- | ---- | -------------
-Name                           | Value | Null | Number Format
------------------------------- | ----- | ---- | -------------
-|- Row 1                       | 1     | -    | 1.00
-|- Row 2                       | 2     | -    | 2.00
-|- Row Name                    | 3     | -    | 3.00
-|- Row Long Name Long Name ... | 4     | -    | 4.00
-|- Row 5 red                   | 5     | -    | 5.00
-|- Row 6 bg green              | 6     | -    | 6.00
-|- Row 7 bright blue           | 7     | -    | 7.00
-|- Row 8 bright bg blue        | 8     | -    | 8.00
-   |- Sub Row 1                | s1    | -    | 11.00
-   |- Sub Row 2                | s2    | -    | 12.00
-   |- Sub Row 3                | s3    | -    | 13.00
------------------------------- | ----- | ---- | -------------
-```
 
-# Test Example
-[test.js](test.js)
+# Example test
+[test.js](test/test.js)
 ```
-node test.js
+npm run test
 ```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26034

increased by20.86%

Lines of code

700

increased by19.86%

Worsened metrics

Number of lines in readme file

79

decreased by-38.76%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes