Consistency schema and typing

gajus · Apr 26, 2021 · f06e203 · f06e203
1 parent 8148dde
commit f06e203
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 81 deletions.
diff --git a/src/calculateColumnWidths.ts b/src/calculateColumnWidths.ts
@@ -7,10 +7,6 @@ import type {
  * Produces an array of values that describe the largest value length (width) in every column.
  */
 export default (rows: Row[]): number[] => {
-  if (!rows[0]) {
-    throw new Error('Dataset must have at least one row.');
-  }
-
   const columnWidths = new Array(rows[0].length).fill(0);
 
   rows.forEach((row) => {

diff --git a/src/makeStreamConfig.ts b/src/makeStreamConfig.ts
@@ -53,14 +53,10 @@ export default (userConfig: StreamUserConfig): StreamConfig => {
 
   const config = cloneDeep(userConfig);
 
-  if (!config.columnDefault || !config.columnDefault.width) {
+  if (config.columnDefault.width === undefined) {
     throw new Error('Must provide config.columnDefault.width when creating a stream.');
   }
 
-  if (!config.columnCount) {
-    throw new Error('Must provide config.columnCount.');
-  }
-
   return {
     ...config,
     border: makeBorder(config.border),

diff --git a/src/schemas/shared.json b/src/schemas/shared.json
@@ -33,9 +33,7 @@
                     ]
                 },
                 "width": {
-                    "type": "number",
-                    "minimum": 1,
-                    "multipleOf": 1.0
+                    "$ref": "#/definitions/naturalNumber"
                 },
                 "wrapWord": {
                     "type": "boolean"
@@ -105,6 +103,11 @@
         },
         "border": {
             "type": "string"
+        },
+        "naturalNumber": {
+          "type": "number",
+          "minimum": 1,
+          "multipleOf": 1.0
         }
     }
 }
diff --git a/src/schemas/streamConfig.json b/src/schemas/streamConfig.json
@@ -13,11 +13,12 @@
             "$ref": "shared.json#/definitions/column"
         },
         "columnCount": {
-            "type": "number"
+            "$ref": "shared.json#/definitions/naturalNumber"
         },
         "drawVerticalLine": {
-          "typeof": "function"
+            "typeof": "function"
         }
     },
-    "additionalProperties": false
+  "required": ["columnDefault", "columnCount"],
+  "additionalProperties": false
 }
diff --git a/test/calculateColumnWidths.ts b/test/calculateColumnWidths.ts
@@ -5,11 +5,6 @@ import chalk from 'chalk';
 import calculateColumnWidths from '../src/calculateColumnWidths';
 
 describe('calculateColumnWidths', () => {
-  it('throws an error when attempting to calculate maximum column value index for an empty data set', () => {
-    expect(() => {
-      calculateColumnWidths([]);
-    }).to.throw(Error, 'Dataset must have at least one row.');
-  });
   it('calculates the maximum column value index', () => {
     const columnWidths = calculateColumnWidths([
       [

diff --git a/test/createStream.ts b/test/createStream.ts
@@ -10,21 +10,13 @@ import getBorderCharacters from '../src/getBorderCharacters';
 
 describe('createStream', () => {
   context('"config.columnDefault.width" property is not provided', () => {
-    it('throws an error', () => {
-      expect(() => {
-        createStream({} as never);
-      }).to.throw(Error, 'Must provide config.columnDefault.width when creating a stream.');
-    });
-  });
-  context('"config.columnCount" property is not provided', () => {
     it('throws an error', () => {
       expect(() => {
         createStream({
-          columnDefault: {
-            width: 10,
-          },
+          columnCount: 1,
+          columnDefault: {},
         } as never);
-      }).to.throw(Error, 'Must provide config.columnCount.');
+      }).to.throw(Error, 'Must provide config.columnDefault.width when creating a stream.');
     });
   });
   context('Table data cell count does not match the columnCount.', () => {

diff --git a/test/makeStreamConfig.ts b/test/makeStreamConfig.ts
@@ -23,15 +23,7 @@ describe('makeStreamConfig', () => {
   });
 
   context('columnDefault', () => {
-    context('is not provided', () => {
-      it('throws an error', () => {
-        expect(() => {
-          return makeStreamConfig({columnCount: 2} as never);
-        }).to.be.throw('Must provide config.columnDefault.width when creating a stream.');
-      });
-    });
-
-    context('is provided but not contains width', () => {
+    context('not contains width', () => {
       it('throws an error', () => {
         expect(() => {
           return makeStreamConfig({columnCount: 2,
@@ -41,16 +33,6 @@ describe('makeStreamConfig', () => {
     });
   });
 
-  context('columnCount', () => {
-    context('is not provided', () => {
-      it('throws an error', () => {
-        expect(() => {
-          return makeStreamConfig({columnDefault: {width: 5}} as never);
-        }).to.be.throw('Must provide config.columnCount.');
-      });
-    });
-  });
-
   context('column', () => {
     context('alignment', () => {
       context('is not provided', () => {

diff --git a/test/streamConfigSamples.ts b/test/streamConfigSamples.ts
@@ -4,6 +4,7 @@ import type {
 
 const streamConfigSamples: {invalid: unknown[], valid: StreamUserConfig[], } = {
   invalid: [
+    {},
     {border: 1},
     {border: {unknown: '-'}},
     {border: {topBody: 1}},
@@ -97,39 +98,35 @@ const streamConfigSamples: {invalid: unknown[], valid: StreamUserConfig[], } = {
       columnDefault: {width: 1.5},
     },
 
-    // eslint-disable-next-line no-warning-comments
-    // TODO: Fix the schema so that the following configs are truly invalid
-    // {border: {topBody: '-'}},
-    // {border: {topJoin: '-'}},
-    // {border: {topLeft: '-'}},
-    // {border: {topRight: '-'}},
-    // {border: {bottomBody: '-'}},
-    // {border: {bottomJoin: '-'}},
-    // {border: {bottomLeft: '-'}},
-    // {border: {bottomRight: '-'}},
-    // {border: {bodyLeft: '-'}},
-    // {border: {bodyRight: '-'}},
-    // {border: {bodyJoin: '-'}},
-    // {border: {joinBody: '-'}},
-    // {border: {joinLeft: '-'}},
-    // {border: {joinRight: '-'}},
-    // {border: {joinJoin: '-'}},
-    // {columns: {1: {alignment: 'left'}}},
-    // {columns: {1: {width: 5}}},
-    // {columns: {1: {wrapWord: true}}},
-    // {columns: {1: {truncate: 1}}},
-    // {columns: {1: {paddingLeft: 1}}},
-    // {columns: {1: {paddingRight: 1}}},
-    // {columnDefault: {alignment: 'left'}},
-    // {columnDefault: {width: 5}},
-    // {columnDefault: {wrapWord: true}},
-    // {columnDefault: {truncate: 1}},
-    // {columnDefault: {paddingLeft: 1}},
-    // {columnDefault: {paddingRight: 1}},
+    {border: {topBody: '-'}},
+    {border: {topJoin: '-'}},
+    {border: {topLeft: '-'}},
+    {border: {topRight: '-'}},
+    {border: {bottomBody: '-'}},
+    {border: {bottomJoin: '-'}},
+    {border: {bottomLeft: '-'}},
+    {border: {bottomRight: '-'}},
+    {border: {bodyLeft: '-'}},
+    {border: {bodyRight: '-'}},
+    {border: {bodyJoin: '-'}},
+    {border: {joinBody: '-'}},
+    {border: {joinLeft: '-'}},
+    {border: {joinRight: '-'}},
+    {border: {joinJoin: '-'}},
+    {columns: {1: {alignment: 'left'}}},
+    {columns: {1: {width: 5}}},
+    {columns: {1: {wrapWord: true}}},
+    {columns: {1: {truncate: 1}}},
+    {columns: {1: {paddingLeft: 1}}},
+    {columns: {1: {paddingRight: 1}}},
+    {columnDefault: {alignment: 'left'}},
+    {columnDefault: {width: 5}},
+    {columnDefault: {wrapWord: true}},
+    {columnDefault: {truncate: 1}},
+    {columnDefault: {paddingLeft: 1}},
+    {columnDefault: {paddingRight: 1}},
   ],
   valid: [
-    // FIXME: The empty option pass the validator but be threw in runtime
-    {} as never,
     {
       columnCount: 1,
       columnDefault: {width: 1},