add comments

lib/analyzer.js

@@ -3,9 +3,12 @@ var gzipSize = require('gzip-size');
 
 /**
  * Analyzer class
- * @param rules
- * @param selectors
- * @param declarations
+ * @param {Array} rules
+ * @param {Array} selectors
+ * @param {Array} declarations
+ * @param {String} cssString
+ * @param {Number} cssSize
+ * @param {Object} options
  * @constructor
  */
 function Analyzer(rules, selectors, declarations, cssString, cssSize, options) {
@@ -39,9 +42,13 @@ function Analyzer(rules, selectors, declarations, cssString, cssSize, options) {
  * }
  */
 Analyzer.prototype.analyzeRules = function () {
+
+    // object to return
     var result = {
         cssDeclarations: []
     };
+
+    // analyze rules
     this.rules.forEach(function(rule) {
         if (Array.isArray(rule.declarations)) {
             result.cssDeclarations.push({
@@ -50,9 +57,12 @@ Analyzer.prototype.analyzeRules = function () {
             });
         }
     });
+
+    // sort by css declaration count
     result.cssDeclarations.sort(function decreasingOrder(a, b) {
         return b.count - a.count;
     });
+
     return result;
 };
 
@@ -82,18 +92,28 @@ Analyzer.prototype.analyzeSelectors = function () {
 
     // analyze selectors
     this.selectors.forEach(function(selector) {
+
+        // if it contains #
         if (selector.indexOf('#') > -1) {
             result.idSelectors += 1;
         }
+
+        // if it contains *
         if (selector.indexOf('*') > -1) {
             result.universalSelectors += 1;
         }
+
+        // if it is unqualified attribute selector
         if (selector.trim().match(/\[.+\]$/g)) {
             result.unqualifiedAttributeSelectors += 1;
         }
+
+        // if it is for JavaScript hook
         if (regexp.test(selector.trim())) {
             result.javascriptSpecificSelectors += 1;
         }
+
+        // add selector for statistics
         var trimmedSelector = selector.replace(/\s?([\>|\+|\~])\s?/g, '$1');
         trimmedSelector = trimmedSelector.replace(/\s+/g, ' ');
         var count = trimmedSelector.split(/\s|\>|\+|\~/).length;
@@ -102,9 +122,12 @@ Analyzer.prototype.analyzeSelectors = function () {
             count: count
         });
     });
+
+    // sort by chained selector count
     result.identifiers.sort(function decreasingOrder(a, b) {
         return b.count - a.count;
     });
+
     return result;
 };
 
@@ -133,23 +156,35 @@ Analyzer.prototype.analyzeDeclarations = function () {
 
     // analyze declarations
     this.declarations.forEach(function(declaration) {
+
+        // if it contains DataURI
         if (declaration.value.indexOf('data:image') > -1) {
             result.dataUriSize += declaration.value.match(/data\:image\/[A-Za-z0-9;,\+\=\/]+/);
         }
+
+        // if it contains !important keyword
         if (declaration.value.indexOf('!important') > -1) {
             result.importantKeywords += 1;
         }
+
+        // if it contains float
         if (declaration.property.indexOf('float') > -1) {
             result.floatProperties += 1;
         }
+
+        // if it contains font-size
         if (declaration.property.indexOf('font-size') > -1) {
             result.uniqueFontSize.push(declaration.value.replace(/\!important/, '').trim());
         }
+
+        // if it contains colors
         if (declaration.property.match(/^color$/)) {
             var color = declaration.value.replace(/\!important/, '');
             color = color.toUpperCase().trim();
             result.uniqueColor.push(color);
         }
+
+        // property statistics
         if (result.properties[declaration.property]) {
             result.properties[declaration.property] += 1;
         } else {
@@ -176,6 +211,8 @@ Analyzer.prototype.analyzeDeclarations = function () {
             count: result.properties[key]
         });
     });
+
+    // sort by property count
     result.properties = propertiesCount.sort(function decreasingOrder(a, b) {
         return b.count - a.count;
     });

lib/parser.js

@@ -5,9 +5,10 @@ var Promise = require('promise');
 var cssParse = require('css-parse');
 var request = require('request');
 
+
 /**
- * get promised request
- * @param url
+ * Get promised request
+ * @param {String} url
  * @returns {Promise}
  */
 function requestSync(url) {
@@ -33,13 +34,24 @@ function requestSync(url) {
 function Parser(urls, files) {
     this.urls = urls;
     this.files = files;
+    this.styles = [];
 }
 
+/**
+ * Add css string
+ * @param {String} style
+ */
+Parser.prototype.addString = function (style) {
+    this.styles.push(style);
+};
+
 /**
  * Parse css data
- * @param callback
+ * @param {Function} callback
  */
 Parser.prototype.parse = function (callback) {
+
+    // object to return
     var result = {
         cssString: '',
         cssSize: 0,
@@ -49,6 +61,8 @@ Parser.prototype.parse = function (callback) {
         declarations: []
     };
 
+    var that = this;
+
     // remote file requests
     var requestPromises = [];
     this.urls.forEach(function(url) {
@@ -57,24 +71,27 @@ Parser.prototype.parse = function (callback) {
 
     // css string array from arguments
     // they will be joined into css string
-    var styles = [];
     this.files.forEach(function(file) {
         // push local css data
-        styles.push(fs.readFileSync(file, {
+        that.styles.push(fs.readFileSync(file, {
             encoding: "utf-8"
         }));
     });
 
+    // get remote files
     Promise.all(requestPromises).done(function onFulfilled(value) {
+
         // push remote css data
-        styles.push(value.join(''));
+        that.styles.push(value.join(''));
 
         // join all css string
-        result.cssString = styles.join('');
+        result.cssString = that.styles.join('');
         result.cssSize = Buffer.byteLength(result.cssString, 'utf8');
 
         // parse css string
         var rawRules = cssParse(result.cssString).stylesheet.rules;
+
+        // add rules into result
         rawRules.forEach(function(rule) {
             if (rule.type === 'rule') {
                 result.rules.push(rule);
@@ -88,6 +105,7 @@ Parser.prototype.parse = function (callback) {
             }
         });
 
+        // add selectors and declarations into result
         result.rules.forEach(function(rule) {
             rule.selectors.forEach(function(selector) {
                 result.selectors.push(selector);
@@ -109,4 +127,5 @@ Parser.prototype.parse = function (callback) {
     });
 };
 
+// export
 module.exports = Parser;

lib/stylestats.js

@@ -19,8 +19,8 @@ var Analyzer = require('./analyzer');
 
 /**
  * StyleStats class
- * @param args
- * @param config
+ * @param {Array} args
+ * @param {String|Object} config
  * @constructor
  */
 function StyleStats(args, config) {
@@ -53,8 +53,6 @@ function StyleStats(args, config) {
             });
         }
     });
-
-    this.parser = new Parser(this.urls, this.files);
 
     var defaultOptions = require('./default.json');
     var customOptions = {};
@@ -70,7 +68,9 @@ function StyleStats(args, config) {
     } else if (_.isObject(config)) {
         customOptions = config;
     }
+
     this.options = _.extend({}, defaultOptions, customOptions);
+    this.parser = new Parser(this.urls, this.files);
 }
 
 /**

lib/util.js

@@ -1,6 +1,10 @@
 var fs = require('fs');
 var path = require('path');
 
+/**
+ * Argument is file path or not
+ * @returns {Boolean}
+ */
 function isFile() {
     try {
         var file = path.join.apply(path, arguments);
@@ -10,6 +14,10 @@ function isFile() {
     }
 }
 
+/**
+ * Argument is directory path or not
+ * @returns {Boolean}
+ */
 function isDirectory() {
     try {
         var dir = path.join.apply(path, arguments);