1. module purify-css
   1. function purify-css (searchThrough, css, options, callback)
   2. function purify-css.CssTreeWalker (code, plugins)
   3. function purify-css.SelectorFilter (contentWords, whitelist)
   4. object purify-css.CssTreeWalker.prototype
   5. object purify-css.ExtractWordsUtil
   6. object purify-css.FileUtil
   7. object purify-css.PrintUtil
   8. object purify-css.SelectorFilter.prototype
2. module purify-css.CssTreeWalker
   1. function purify-css.CssTreeWalker (code, plugins)
3. module purify-css.CssTreeWalker.prototype
   1. function purify-css.CssTreeWalker.prototype.beginReading ()
   2. function purify-css.CssTreeWalker.prototype.constructor (code, plugins)
   3. function purify-css.CssTreeWalker.prototype.readPlugin (tree)
   4. function purify-css.CssTreeWalker.prototype.readRules (rules)
   5. function purify-css.CssTreeWalker.prototype.removeEmptyRules (rules)
   6. function purify-css.CssTreeWalker.prototype.toString ()
4. module purify-css.ExtractWordsUtil
   1. function purify-css.ExtractWordsUtil.getAllWordsInContent (content)
   2. function purify-css.ExtractWordsUtil.getAllWordsInSelector (selector)
5. module purify-css.FileUtil
   1. function purify-css.FileUtil.compressCode (code)
   2. function purify-css.FileUtil.concatFiles (files, options)
   3. function purify-css.FileUtil.filesToSource (files, type)
   4. function purify-css.FileUtil.getFilesFromPatternArray (fileArray)
6. module purify-css.PrintUtil
   1. function purify-css.PrintUtil.printInfo (endingLength)
   2. function purify-css.PrintUtil.printRejected (rejectedTwigs)
   3. function purify-css.PrintUtil.startLog (cssLength)
7. module purify-css.SelectorFilter
   1. function purify-css.SelectorFilter (contentWords, whitelist)
8. module purify-css.SelectorFilter.prototype
   1. function purify-css.SelectorFilter.prototype.filterSelectors (selectors)
   2. function purify-css.SelectorFilter.prototype.initialize (CssSyntaxTree)
   3. function purify-css.SelectorFilter.prototype.parseRule (selectors, rule)
   4. function purify-css.SelectorFilter.prototype.parseWhitelist (whitelist)

module purify-css

function purify-css (searchThrough, css, options, callback)

• description and source-code

  purify-css = function (searchThrough, css, options, callback) {
    if (typeof options === 'function') {
      callback = options;
      options = {};
    }
    options = getOptions(options);
  
    var cssString = FileUtil.filesToSource(css, 'css');
    var content = FileUtil.filesToSource(searchThrough, 'content');
  
    PrintUtil.startLog(minify(cssString).length);
  
    var wordsInContent = getAllWordsInContent(content);
  
    var selectorFilter = new SelectorFilter(wordsInContent, options.whitelist);
  
    var tree = new CssTreeWalker(cssString, [selectorFilter]);
    tree.beginReading();
    var source = tree.toString();
  
    if (options.minify) {
      source = minify(source);
    }
  
    if (options.info && options.minify) {
      PrintUtil.printInfo(source.length);
    } else if (options.info && !options.minify) {
      PrintUtil.printInfo(minify(source).length);
    }
  
    if (options.rejected) {
      PrintUtil.printRejected(selectorFilter.rejectedSelectors);
    }
  
    if (!options.output) {
      return callback ? callback(source) : source;
    } else {
      fs.writeFile(options.output, source, function (err) {
        if (err) {
          return err;
        }
      });
    }
  }

• example usage

  n/a

function purify-css.CssTreeWalker (code, plugins)

• description and source-code

  CssTreeWalker = function (code, plugins) {
    EventEmitter.call(this);
    this.startingSource = code;
    this.ast = null;
  
    plugins.forEach(function (plugin) {
      plugin.initialize(this);
    }.bind(this));
  }

• example usage

  n/a

function purify-css.SelectorFilter (contentWords, whitelist)

• description and source-code

  SelectorFilter = function (contentWords, whitelist) {
    this.contentWords = contentWords;
    this.rejectedSelectors = [];
    this.wildcardWhitelist = [];
  
    this.parseWhitelist(whitelist);
  }

• example usage

  n/a

module purify-css.CssTreeWalker

function purify-css.CssTreeWalker (code, plugins)

• description and source-code

  CssTreeWalker = function (code, plugins) {
    EventEmitter.call(this);
    this.startingSource = code;
    this.ast = null;
  
    plugins.forEach(function (plugin) {
      plugin.initialize(this);
    }.bind(this));
  }

• example usage

  n/a

module purify-css.CssTreeWalker.prototype

function purify-css.CssTreeWalker.prototype.beginReading ()

• description and source-code

  beginReading = function () {
    this.ast = rework(this.startingSource)
      .use(this.readPlugin.bind(this));
  }

• example usage

  ...
  PrintUtil.startLog(minify(cssString).length);
  
  var wordsInContent = getAllWordsInContent(content);
  
  var selectorFilter = new SelectorFilter(wordsInContent, options.whitelist);
  
  var tree = new CssTreeWalker(cssString, [selectorFilter]);
  tree.beginReading();
  var source = tree.toString();
  
  if (options.minify) {
    source = minify(source);
  }
  
  if (options.info && options.minify) {
  ...

function purify-css.CssTreeWalker.prototype.constructor (code, plugins)

• description and source-code

  constructor = function (code, plugins) {
    EventEmitter.call(this);
    this.startingSource = code;
    this.ast = null;
  
    plugins.forEach(function (plugin) {
      plugin.initialize(this);
    }.bind(this));
  }

• example usage

  n/a

function purify-css.CssTreeWalker.prototype.readPlugin (tree)

• description and source-code

  readPlugin = function (tree) {
    this.readRules(tree.rules);
    this.removeEmptyRules(tree.rules);
  }

• example usage

  n/a

function purify-css.CssTreeWalker.prototype.readRules (rules)

• description and source-code

  readRules = function (rules) {
    rules.forEach(function (rule) {
      var ruleType = rule.type;
  
      if (ruleType === RULE_TYPE) {
        this.emit('readRule', rule.selectors, rule);
      }
  
      if (ruleType === MEDIA_TYPE) {
        this.readRules(rule.rules);
      }
    }.bind(this));
  }

• example usage

  ...
  
  CssTreeWalker.prototype.beginReading = function () {
  this.ast = rework(this.startingSource)
    .use(this.readPlugin.bind(this));
  };
  
  CssTreeWalker.prototype.readPlugin = function (tree) {
  this.readRules(tree.rules);
  this.removeEmptyRules(tree.rules);
  };
  
  CssTreeWalker.prototype.readRules = function (rules) {
  rules.forEach(function (rule) {
    var ruleType = rule.type;
  ...

function purify-css.CssTreeWalker.prototype.removeEmptyRules (rules)

• description and source-code

  removeEmptyRules = function (rules) {
    var emptyRules = [];
  
    rules.forEach(function (rule) {
      var ruleType = rule.type;
  
      if (ruleType === RULE_TYPE && rule.selectors.length === 0) {
        emptyRules.push(rule);
      }
  
      if (ruleType === MEDIA_TYPE) {
        this.removeEmptyRules(rule.rules);
        if (rule.rules.length === 0) {
          emptyRules.push(rule);
        }
      }
    }.bind(this));
  
    emptyRules.forEach(function (emptyRule) {
      var index = rules.indexOf(emptyRule);
      rules.splice(index, 1);
    });
  }

• example usage

  ...
  CssTreeWalker.prototype.beginReading = function () {
    this.ast = rework(this.startingSource)
  .use(this.readPlugin.bind(this));
  };
  
  CssTreeWalker.prototype.readPlugin = function (tree) {
    this.readRules(tree.rules);
    this.removeEmptyRules(tree.rules);
  };
  
  CssTreeWalker.prototype.readRules = function (rules) {
    rules.forEach(function (rule) {
  var ruleType = rule.type;
  
  if (ruleType === RULE_TYPE) {
  ...

function purify-css.CssTreeWalker.prototype.toString ()

• description and source-code

  toString = function () {
    if (this.ast) {
      return this.ast.toString().replace(/,\n/g, ',');
    }
  
    return '';
  }

• example usage

  ...
      this.readRules(rule.rules);
    }
  }.bind(this));
  };
  
  CssTreeWalker.prototype.toString = function () {
  if (this.ast) {
    return this.ast.toString().replace(/,\n/g, ',');
  }
  
  return '';
  };
  
  CssTreeWalker.prototype.removeEmptyRules = function (rules) {
  var emptyRules = [];
  ...

module purify-css.ExtractWordsUtil

function purify-css.ExtractWordsUtil.getAllWordsInContent (content)

• description and source-code

  getAllWordsInContent = function (content) {
    var used = {
      // Always include html and body.
      html: true,
      body: true
    };
    var word = '';
  
    for (var i = 0; i < content.length; i++) {
      var chr = content[i];
  
      if (chr.match(/[a-z]+/)) {
        word += chr;
      } else {
        used[word] = true;
        word = '';
      }
    }
  
    used[word] = true;
  
    return used;
  }

• example usage

  n/a

function purify-css.ExtractWordsUtil.getAllWordsInSelector (selector)

• description and source-code

  getAllWordsInSelector = function (selector) {
    // Remove attr selectors. "a[href...]"" will become "a".
    selector = selector.replace(/\[(.+?)\]/g, '').toLowerCase();
  
    // If complex attr selector (has a bracket in it) just leave
    // the selector in. ¯\_(ツ)_/¯
    if (selector.indexOf('[') !== -1 || selector.indexOf(']') !== -1) {
      return [];
    }
  
    var words = [];
    var word = '';
    var skipNextWord = false;
  
    for (var i = 0; i < selector.length; i++) {
      var letter = selector[i];
  
      if (skipNextWord && (letter !== '.' || letter !== '#' || letter !== ' ')) {
        continue;
      }
  
      // If pseudoclass or universal selector, skip the next word
      if (letter === ':' || letter === '*') {
        addWord(words, word);
        word = '';
        skipNextWord = true;
        continue;
      }
  
      if (letter.match(/[a-z]+/)) {
        word += letter;
      } else {
        addWord(words, word);
        word = '';
        skipNextWord = false;
      }
    }
  
    addWord(words, word);
    return words;
  }

• example usage

  n/a

module purify-css.FileUtil

function purify-css.FileUtil.compressCode (code)

• description and source-code

  compressCode = function (code) {
    try {
      // Try to minimize the code as much as possible, removing noise.
      var ast = UglifyJS.parse(code);
      ast.figure_out_scope();
      /* eslint-disable new-cap */
      var compressor = UglifyJS.Compressor({warnings: false});
      /* eslint-enable new-cap */
      ast = ast.transform(compressor);
      ast.figure_out_scope();
      ast.compute_char_frequency();
      ast.mangle_names({toplevel: true});
      code = ast.print_to_string().toLowerCase();
    } catch (e) {
      // If compression fails, assume it's not a JS file and return the full code.
    }
  
    return code.toLowerCase();
  }

• example usage

  ...
  
  return files.reduce(function (total, file) {
    var code = '';
  
    try {
      code = fs.readFileSync(file, 'utf8');
      if (options.compress) {
        code = FileUtil.compressCode(code);
      }
    } catch (e) {
      console.warn('\nWARNING: Could not read ' + file + '.');
    }
  
    return total + code + ' ';
  }, '');
  ...

function purify-css.FileUtil.concatFiles (files, options)

• description and source-code

  concatFiles = function (files, options) {
    options = options || {};
  
    return files.reduce(function (total, file) {
      var code = '';
  
      try {
        code = fs.readFileSync(file, 'utf8');
        if (options.compress) {
          code = FileUtil.compressCode(code);
        }
      } catch (e) {
        console.warn('\nWARNING: Could not read ' + file + '.');
      }
  
      return total + code + ' ';
    }, '');
  }

• example usage

  ...
  
    filesToSource: function (files, type) {
  var isContent = type === 'content';
  var options = {compress: isContent};
  
  if (Array.isArray(files)) {
    files = FileUtil.getFilesFromPatternArray(files);
    return FileUtil.concatFiles(files, options);
  }
  
  // 'files' is already a source string.
  if (isContent) {
    return FileUtil.compressCode(files);
  } else {
    return files;
  ...

function purify-css.FileUtil.filesToSource (files, type)

• description and source-code

  filesToSource = function (files, type) {
    var isContent = type === 'content';
    var options = {compress: isContent};
  
    if (Array.isArray(files)) {
      files = FileUtil.getFilesFromPatternArray(files);
      return FileUtil.concatFiles(files, options);
    }
  
    // 'files' is already a source string.
    if (isContent) {
      return FileUtil.compressCode(files);
    } else {
      return files;
    }
  }

• example usage

  ...
  var purify = function (searchThrough, css, options, callback) {
  if (typeof options === 'function') {
    callback = options;
    options = {};
  }
  options = getOptions(options);
  
  var cssString = FileUtil.filesToSource(css, 'css');
  var content = FileUtil.filesToSource(searchThrough, 'content');
  
  PrintUtil.startLog(minify(cssString).length);
  
  var wordsInContent = getAllWordsInContent(content);
  
  var selectorFilter = new SelectorFilter(wordsInContent, options.whitelist);
  ...

function purify-css.FileUtil.getFilesFromPatternArray (fileArray)

• description and source-code

  getFilesFromPatternArray = function (fileArray) {
    var sourceFiles = {};
  
    fileArray.forEach(function (string) {
      try {
        // See if string is a filepath, not a file pattern.
        fs.statSync(string);
        sourceFiles[string] = true;
      } catch (e) {
        var files = glob.sync(string);
        files.forEach(function (file) {
          sourceFiles[file] = true;
        });
      }
    });
  
    return Object.keys(sourceFiles);
  }

• example usage

  ...
    },
  
    filesToSource: function (files, type) {
  var isContent = type === 'content';
  var options = {compress: isContent};
  
  if (Array.isArray(files)) {
    files = FileUtil.getFilesFromPatternArray(files);
    return FileUtil.concatFiles(files, options);
  }
  
  // 'files' is already a source string.
  if (isContent) {
    return FileUtil.compressCode(files);
  } else {
  ...

module purify-css.PrintUtil

function purify-css.PrintUtil.printInfo (endingLength)

• description and source-code

  printInfo = function (endingLength) {
    var logFn = console.error;
    logFn.call(null, '##################################');
    logFn.call(null, 'PurifyCSS has reduced the file size by ~' +
      (((beginningLength - endingLength) / beginningLength) * 100).toFixed(1) + '%');
    logFn.call(null, '##################################');
    logFn.call(null, 'This function took: ', new Date() - startTime, 'ms');
  }

• example usage

  ...
  var source = tree.toString();
  
  if (options.minify) {
    source = minify(source);
  }
  
  if (options.info && options.minify) {
    PrintUtil.printInfo(source.length);
  } else if (options.info && !options.minify) {
    PrintUtil.printInfo(minify(source).length);
  }
  
  if (options.rejected) {
    PrintUtil.printRejected(selectorFilter.rejectedSelectors);
  }
  ...

function purify-css.PrintUtil.printRejected (rejectedTwigs)

• description and source-code

  printRejected = function (rejectedTwigs) {
    var logFn = console.error;
    logFn.call(null, '##################################');
    logFn.call(null, 'Rejected selectors:');
    logFn.call(null, rejectedTwigs.join('\n'));
    logFn.call(null, '##################################');
  }

• example usage

  ...
  if (options.info && options.minify) {
    PrintUtil.printInfo(source.length);
  } else if (options.info && !options.minify) {
    PrintUtil.printInfo(minify(source).length);
  }
  
  if (options.rejected) {
    PrintUtil.printRejected(selectorFilter.rejectedSelectors);
  }
  
  if (!options.output) {
    return callback ? callback(source) : source;
  } else {
    fs.writeFile(options.output, source, function (err) {
      if (err) {
  ...

function purify-css.PrintUtil.startLog (cssLength)

• description and source-code

  startLog = function (cssLength) {
    startTime = new Date();
    beginningLength = cssLength;
  }

• example usage

  ...
    options = {};
  }
  options = getOptions(options);
  
  var cssString = FileUtil.filesToSource(css, 'css');
  var content = FileUtil.filesToSource(searchThrough, 'content');
  
  PrintUtil.startLog(minify(cssString).length);
  
  var wordsInContent = getAllWordsInContent(content);
  
  var selectorFilter = new SelectorFilter(wordsInContent, options.whitelist);
  
  var tree = new CssTreeWalker(cssString, [selectorFilter]);
  tree.beginReading();
  ...

module purify-css.SelectorFilter

function purify-css.SelectorFilter (contentWords, whitelist)

• description and source-code

  SelectorFilter = function (contentWords, whitelist) {
    this.contentWords = contentWords;
    this.rejectedSelectors = [];
    this.wildcardWhitelist = [];
  
    this.parseWhitelist(whitelist);
  }

• example usage

  n/a

module purify-css.SelectorFilter.prototype

function purify-css.SelectorFilter.prototype.filterSelectors (selectors)

• description and source-code

  filterSelectors = function (selectors) {
    var contentWords = this.contentWords;
    var rejectedSelectors = this.rejectedSelectors;
    var wildcardWhitelist = this.wildcardWhitelist;
    var usedSelectors = [];
  
    selectors.forEach(function (selector) {
      if (hasWhitelistMatch(selector, wildcardWhitelist)) {
        usedSelectors.push(selector);
        return;
      }
  
      var words = getAllWordsInSelector(selector);
      var usedWords = words.filter(function (word) {
        return contentWords[word];
      });
  
      if (usedWords.length === words.length) {
        usedSelectors.push(selector);
      } else {
        rejectedSelectors.push(selector);
      }
    });
  
    return usedSelectors;
  }

• example usage

  ...
        this.contentWords[word] = true;
      }.bind(this));
    }
  }.bind(this));
  };
  
  SelectorFilter.prototype.parseRule = function (selectors, rule) {
  rule.selectors = this.filterSelectors(selectors);
  };
  
  SelectorFilter.prototype.filterSelectors = function (selectors) {
  var contentWords = this.contentWords;
  var rejectedSelectors = this.rejectedSelectors;
  var wildcardWhitelist = this.wildcardWhitelist;
  var usedSelectors = [];
  ...

function purify-css.SelectorFilter.prototype.initialize (CssSyntaxTree)

• description and source-code

  initialize = function (CssSyntaxTree) {
    CssSyntaxTree.on('readRule', this.parseRule.bind(this));
  }

• example usage

  ...
  
  var CssTreeWalker = function (code, plugins) {
    EventEmitter.call(this);
    this.startingSource = code;
    this.ast = null;
  
    plugins.forEach(function (plugin) {
      plugin.initialize(this);
    }.bind(this));
  };
  
  CssTreeWalker.prototype = Object.create(EventEmitter.prototype);
  CssTreeWalker.prototype.constructor = CssTreeWalker;
  
  CssTreeWalker.prototype.beginReading = function () {
  ...

function purify-css.SelectorFilter.prototype.parseRule (selectors, rule)

• description and source-code

  parseRule = function (selectors, rule) {
    rule.selectors = this.filterSelectors(selectors);
  }

• example usage

  n/a

function purify-css.SelectorFilter.prototype.parseWhitelist (whitelist)

• description and source-code

  parseWhitelist = function (whitelist) {
    whitelist.forEach(function (whitelistSelector) {
      whitelistSelector = whitelistSelector.toLowerCase();
  
      if (isWildcardWhitelistSelector(whitelistSelector)) {
        // If '*button*' then push 'button' onto list.
        this.wildcardWhitelist.push(
          whitelistSelector.substr(1, whitelistSelector.length - 2)
        );
      } else {
        getAllWordsInSelector(whitelistSelector).forEach(function (word) {
          this.contentWords[word] = true;
        }.bind(this));
      }
    }.bind(this));
  }

• example usage

  ...
  }
  
  var SelectorFilter = function (contentWords, whitelist) {
    this.contentWords = contentWords;
    this.rejectedSelectors = [];
    this.wildcardWhitelist = [];
  
    this.parseWhitelist(whitelist);
  };
  
  SelectorFilter.prototype.initialize = function (CssSyntaxTree) {
    CssSyntaxTree.on('readRule', this.parseRule.bind(this));
  };
  
  SelectorFilter.prototype.parseWhitelist = function (whitelist) {
  ...