refactor(utils): Rename metrics/get-metric-type to utils/metrics

relative-ci · Feb 29, 2020 · f5ae1d8 · f5ae1d8
1 parent 98e2769
commit f5ae1d8
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 3 deletions.
diff --git a/packages/utils/src/metrics/index.js b/packages/utils/src/metrics/index.js
diff --git a/packages/utils/src/report/add-row-data.js b/packages/utils/src/report/add-row-data.js
@@ -1,6 +1,6 @@
 import { getDelta, formatDelta } from '../utils/delta';
 import { formatPercentage } from '../utils/format';
-import { getMetricType } from '../metrics/get-metric-type';
+import { getMetricType } from '../utils/metrics';
 import { getMetricChanged } from './get-metric-changed';
 
 export const addRowData = (row, metricType) => {

diff --git a/.../src/metrics/__tests__/get-metric-type.js → ...ls/src/utils/__tests__/get-metric-type.js b/.../src/metrics/__tests__/get-metric-type.js → ...ls/src/utils/__tests__/get-metric-type.js
@@ -1,7 +1,7 @@
 import { omit } from 'lodash';
 
 import { METRIC_TYPE_FILE_SIZE } from '../../config/metrics';
-import { getMetricType } from '../get-metric-type';
+import { getMetricType } from '../metrics';
 
 describe('getMetricType', () => {
   test('should return metric', () => {

diff --git a/packages/utils/src/utils/delta.js b/packages/utils/src/utils/delta.js
@@ -24,6 +24,13 @@ export const getDelta = (baseline, current) => {
   };
 };
 
+/**
+ * Format delta output
+ *
+ * @param {number} value Metric value
+ * @param {Function} formatter Metric type formatter
+ * @return {String} Delta output
+ */
 export const formatDelta = (value, formatter) => {
   // eslint-disable-next-line no-nested-ternary
   let sign = value > 0

diff --git a/packages/utils/src/utils/index.js b/packages/utils/src/utils/index.js
@@ -1,3 +1,4 @@
 export * from './delta';
 export * from './date';
 export * from './format';
+export * from './metrics';
diff --git a/...ages/utils/src/metrics/get-metric-type.js → packages/utils/src/utils/metrics.js b/...ages/utils/src/metrics/get-metric-type.js → packages/utils/src/utils/metrics.js
@@ -2,6 +2,20 @@ import { get } from 'lodash';
 
 import METRICS, { METRIC_TYPE_NUMERIC, METRIC_TYPES } from '../config/metrics';
 
+/**
+ * Get metric type data
+ *
+ * @param {String} key Metric key
+ * @param {String} [type] Default metric type
+ *
+ * @typedef {Object} Metric
+ * @property {String} label Metric label
+ * @property {String} type Metric type
+ * @property {Function} formatter Metric format handler
+ * @property {Boolean} biggerIsBetter Metric flag
+ *
+ * @return @Metric
+ */
 export const getMetricType = (key, type) => {
   const metric = get(METRICS, key);