options.type -> options.view

gribnoysup · Mar 6, 2018 · 427693d · 427693d
1 parent 54b2931
commit 427693d
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 28 deletions.
diff --git a/bin/index.js b/bin/index.js
@@ -10,10 +10,10 @@ process.stdin.on('data', chunk => {
 });
 
 process.stdin.on('end', () => {
-  const { type, sort, min, max, length } = mri(process.argv.slice(2));
+  const { view, sort, min, max, length } = mri(process.argv.slice(2));
 
   const { chart, scale, legend } = draw(JSON.parse(data), {
-    type,
+    view,
     sort,
     min,
     max,

diff --git a/lib/const.js b/lib/const.js
@@ -1,9 +1,9 @@
 /** 
- * Chart print types:
+ * Chart print views:
  *   normal - one bar on one line
  *   condensed - two bars on one line
 */
-const CHART_TYPES = {
+const CHART_VIEWS = {
   Normal: 'normal',
   Condensed: 'condensed',
 };
@@ -30,4 +30,4 @@ const SORT_METHODS = {
   none: Function.prototype,
 };
 
-module.exports = { CHART_TYPES, SYMBOLS, SORT_METHODS };
+module.exports = { CHART_VIEWS, SYMBOLS, SORT_METHODS };
diff --git a/lib/index.js b/lib/index.js
@@ -2,7 +2,7 @@ const chalk = require('chalk');
 const randomColor = require('randomcolor');
 const { width: terminalWidth } = require('window-size');
 
-const { SYMBOLS, SORT_METHODS, CHART_TYPES } = require('./const');
+const { SYMBOLS, SORT_METHODS, CHART_VIEWS } = require('./const');
 
 const { condensedChartReducer, normalChartReducer } = require('./reducers');
 
@@ -19,7 +19,7 @@ const {
  * @param {Array<{ value: number, color?: string, label?: string }>} values values to put on a chart
  *
  * @param {Object} [options] chart drawing options
- * @param {string} [options.type="normal"] chart type, accepts two values: "normal" or "condensed", defaults to "normal"
+ * @param {string} [options.view="normal"] chart view, accepts two values: "normal" or "condensed", defaults to "normal"
  * @param {number} [options.min] min chart value (inclusive), zero point for the chart, defaults to min value from values array
  * @param {number} [options.max] max chart value (inclusive), maximum value on the chart, defaults to max value from values array
  * @param {number} [options.length] chart length, defaults to all available space in terminal window
@@ -36,7 +36,7 @@ const {
 function draw(values = [], options = {}) {
   values = normalizeValues(values);
 
-  const { randomColorOptions, type, sort, min, max, length } = normalizeOptions(
+  const { randomColorOptions, view, sort, min, max, length } = normalizeOptions(
     options
   );
 
@@ -85,11 +85,11 @@ function draw(values = [], options = {}) {
     .slice()
     .sort(typeof sort === 'function' ? sort : SORT_METHODS[sort]);
 
-  if (type === CHART_TYPES.Normal) {
+  if (view === CHART_VIEWS.Normal) {
     chart = chart.reduce(normalChartReducer, '');
   }
 
-  if (type === CHART_TYPES.Condensed) {
+  if (view === CHART_VIEWS.Condensed) {
     chart = chart.reduce(condensedChartReducer, '');
   }
 

diff --git a/lib/normalizers.js b/lib/normalizers.js
@@ -1,4 +1,4 @@
-const { CHART_TYPES, SORT_METHODS } = require('./const');
+const { CHART_VIEWS, SORT_METHODS } = require('./const');
 
 const methods = Object.keys(SORT_METHODS);
 
@@ -35,13 +35,13 @@ const normalizeValues = values => {
 
 const normalizeOptions = options => {
   if (
-    options.type &&
-    options.type !== CHART_TYPES.Normal &&
-    options.type !== CHART_TYPES.Condensed
+    options.view &&
+    options.view !== CHART_VIEWS.Normal &&
+    options.view !== CHART_VIEWS.Condensed
   ) {
     throw new TypeError(
-      `Unexpected options.type: ${prettify(
-        options.type
+      `Unexpected options.view: ${prettify(
+        options.view
       )}. Expected "normal" | "condensed"`
     );
   }
@@ -91,7 +91,7 @@ const normalizeOptions = options => {
   }
 
   return {
-    type: options.type || CHART_TYPES.Normal,
+    view: options.view || CHART_VIEWS.Normal,
     max: typeof options.max !== 'undefined' ? parseFloat(options.max) : void 0,
     min: typeof options.min !== 'undefined' ? parseFloat(options.min) : void 0,
     length:

diff --git a/tests/__snapshots__/index.test.js.snap b/tests/__snapshots__/index.test.js.snap
@@ -2,13 +2,13 @@
 
 exports[`draw should provide result with chart, scale and legend 1`] = `
 "
-█████████████████████
+█████████
 
-███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████
-███████████████████████████████████
-█████████████████████████████████████████████████████████████████████████████████████████████
+████████████████████████████████████████████████████████████████████████████████████████████████████
+███████████████
+███████████████████████████████████████
 
-◺ 8131788.00                                                                                                                                                                                                                  32601939.00 ◿
+◺ 8131788.00                                                                           32601939.00 ◿
 
 █ -  0-14 10333117.00
 █ - 15-24  8131788.00

diff --git a/tests/__snapshots__/normalizers.test.js.snap b/tests/__snapshots__/normalizers.test.js.snap
@@ -17,7 +17,7 @@ Object {
   "min": 1.23,
   "randomColorOptions": Object {},
   "sort": "none",
-  "type": "normal",
+  "view": "normal",
 }
 `;
 
@@ -28,7 +28,7 @@ Object {
   "min": undefined,
   "randomColorOptions": Object {},
   "sort": "none",
-  "type": "normal",
+  "view": "normal",
 }
 `;
 
@@ -44,7 +44,7 @@ exports[`normalizers normalizeOptions should throw if sort is not a function 1`]
 
 exports[`normalizers normalizeOptions should throw if sort type is not supported 1`] = `"Unexpected options.sort: \\"magic\\". Expected function or \\"min\\" | \\"max\\" | \\"none\\""`;
 
-exports[`normalizers normalizeOptions should throw if type is not supported 1`] = `"Unexpected options.type: \\"boring\\". Expected \\"normal\\" | \\"condensed\\""`;
+exports[`normalizers normalizeOptions should throw if view is not supported 1`] = `"Unexpected options.view: \\"boring\\". Expected \\"normal\\" | \\"condensed\\""`;
 
 exports[`normalizers normalizeValues should normalize Array<number> to Array<{ value: number }> 1`] = `
 Array [

diff --git a/tests/index.test.js b/tests/index.test.js
@@ -10,6 +10,6 @@ describe('draw', () => {
   };
 
   it('should provide result with chart, scale and legend', () => {
-    expect(outputResult(data)).toMatchSnapshot();
+    expect(outputResult(data, { length: 100 })).toMatchSnapshot();
   });
 });
diff --git a/tests/normalizers.test.js b/tests/normalizers.test.js
@@ -34,9 +34,9 @@ describe('normalizers', () => {
   });
 
   describe('normalizeOptions', () => {
-    it('should throw if type is not supported', () => {
+    it('should throw if view is not supported', () => {
       expect(() =>
-        normalizeOptions({ type: 'boring' })
+        normalizeOptions({ view: 'boring' })
       ).toThrowErrorMatchingSnapshot();
     });