Add stats unit test, update jsdoc comments, update arguments so addon option will be listed in --help.

Author: jkeen

lib/arguments.js

@@ -54,6 +54,10 @@ module.exports = {
         default: false,
         describe: 'throw errors when unused components are found',
       })
+      .option('include-addons', {
+        alias: 'a',
+        describe: 'include addons matching wildcard or boolean',
+      })
       .locale('en').argv;
 
     return this.argv;

lib/stats.js

@@ -4,7 +4,7 @@ module.exports = {
   /**
    * Counts using `component "component-name"` usage in templates
    *
-   * @param {object} stats
+   * @param {object} components
    * @returns {number}
    */
   countComponentHelpers(components) {
@@ -21,7 +21,7 @@ module.exports = {
    * Counts components invocations in JS files.
    * That could happen through `import` or by referring by name in configuration of an script or so.
    *
-   * @param {object} stats
+   * @param {object} components
    * @returns {number}
    */
   countJsUsage(components) {
@@ -37,7 +37,7 @@ module.exports = {
   /**
    * Counts components that were used just once.
    *
-   * @param {object} stats
+   * @param {object} components
    * @returns {number}
    */
   countUsedJustOnce(components) {
@@ -55,7 +55,7 @@ module.exports = {
   /**
    * Creates a breakdown between {{curly-braces}} and <AngleBrackets> components syntax usage.
    *
-   * @param {object} stats
+   * @param {object} components
    * @returns {{curly: number, angle: number, curlyPercentage: number, anglePercentage: number}}
    */
   curlyVsAngle(components) {
@@ -83,18 +83,18 @@ module.exports = {
    *
    * In case of the same number of occurrences for multiple component, the first on the list is returned.
    *
-   * @param {object} stats
+   * @param {object} components
    * @returns {object|null}
    */
   getTheMostCommon(components) {
     let max = null;
 
     for (const key of Object.keys(components)) {
-      if (!max || max.count < components[key].count) {
-        max = components[key].key;
+      if (!max || max.stats.count < components[key].stats.count) {
+        max = components[key];
       }
     }
 
-    return components[max];
+    return max;
   },
 };

tests/unit/stats-test.js

@@ -0,0 +1,33 @@
+import test from 'ava';
+const utils = require('../../lib/utils');
+const analyser = require('../../lib/analyser');
+const stats = require('../../lib/stats');
+
+function setup() {
+  let commandOptions = { path: '/test-apps/ember_lts_3_4_with_addons/', includeAddons: true };
+  let config = utils.getConfig(commandOptions);
+  analyser.mapComponents(config);
+  analyser.scanProject(config);
+  analyser.respectWhitelist(config.whitelist);
+
+  return analyser.components;
+}
+
+test('it calculates most common component', t => {
+  let components = setup();
+  let common = stats.getTheMostCommon(components);
+  t.is(common.key, 'y-button');
+  t.is(common.stats.count, 7);
+});
+
+test('it calculates most curly vs bracket breakdown', t => {
+  let components = setup();
+
+  let breakdown = stats.curlyVsAngle(components);
+  t.deepEqual(breakdown, {
+    curly: 10,
+    curlyPercentage: 45.45454545454545,
+    angle: 12,
+    anglePercentage: 54.54545454545454,
+  });
+});