initial commit

Author: olegskl

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "env": {
+    "node": true
+  },
+  "extends": "meetic"
+}

.esnextcoverage.js

@@ -0,0 +1,11 @@
+module.exports = {
+  only: 'src/**/*.js',
+  reporters: [
+    {
+      formatter: function () {
+        return require('./src').apply(null, arguments);
+      },
+      console: true
+    }
+  ]
+};

.gitignore

@@ -0,0 +1,17 @@
+# Compiled files
+dist
+
+# Dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# node-waf configuration
+.lock-wscript

.npmignore

@@ -0,0 +1 @@
+src

.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: node_js
+node_js:
+  - 6
+  - 5
+  - 4
+  - 0.12

README.md

@@ -0,0 +1,53 @@
+# esnext-coverage-format-text
+
+[![NPM version](http://img.shields.io/npm/v/esnext-coverage-format-text.svg)](https://www.npmjs.org/package/esnext-coverage-format-text)
+[![Build Status](https://travis-ci.org/olegskl/esnext-coverage-format-text.svg?branch=master)](https://travis-ci.org/olegskl/esnext-coverage-format-text)
+
+Code coverage reporter for [esnext-coverage](https://github.com/esnext-coverage/esnext-coverage).
+
+Similar to other coverage formatters, esnext-coverage-format-text accepts a coverage results object and produces a report as an utf8-encoded string.
+
+## Installation
+
+```bash
+npm install esnext-coverage-format-text --save-dev
+```
+
+## Usage
+
+### Usage with test frameworks
+
+Add esnext-coverage-format-text to the list of reporters in [esnext-coverage configuration object](https://github.com/esnext-coverage/karma-esnext-coverage-reporter#usage) or to your karma configuration file.
+
+```js
+reporters: [
+  {
+    formatter: 'text', // require esnext-coverage-format-text
+    outFile: 'reports/text-report.txt', // write output to file
+    console: true // output to console
+  }
+]
+```
+
+### Usage with esnext-coverage cli
+
+```bash
+esnext-coverage format coverage.json -f text -o report.txt
+```
+
+### Usage in Node
+
+```js
+import fs from 'fs';
+import formatter from 'esnext-coverage-format-text';
+
+fs.readFile('coverage.json', 'utf8', (err, data) => {
+  const coverage = JSON.parse(data);
+  const report = formatter(coverage);
+  fs.writeFile('text-report.txt', report);
+});
+```
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "esnext-coverage-format-text",
+  "version": "0.0.0",
+  "description": "esnext-coverage output formatter to human-readable text",
+  "main": "dist/index.js",
+  "scripts": {
+    "transpile": "babel src --out-dir dist",
+    "lint": "eslint --ignore-path .gitignore .",
+    "spec": "mocha --slow 200 -r esnext-coverage test/spec/**/*.spec.js",
+    "test": "npm run lint && npm run spec",
+    "prepublish": "npm run test && npm run transpile"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/olegskl/esnext-coverage-format-text.git"
+  },
+  "keywords": [
+    "coverage",
+    "esnext-coverage",
+    "text"
+  ],
+  "author": "Oleg Sklyanchuk <[email protected]> (http://olegskl.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/olegskl/esnext-coverage-format-text/issues"
+  },
+  "homepage": "https://github.com/olegskl/esnext-coverage-format-text",
+  "dependencies": {
+    "esnext-coverage-analytics": "^0.0.2",
+    "chalk": "^1.1.3"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.14.0",
+    "babel-core": "^6.14.0",
+    "babel-preset-es2015": "^6.14.0",
+    "chai": "^3.5.0",
+    "eslint": "^3.4.0",
+    "eslint-config-meetic": "^2.0.0",
+    "esnext-coverage": "^0.0.1",
+    "mocha": "^3.0.2"
+  }
+}

src/colors.js

@@ -0,0 +1,18 @@
+/**
+ * Color functions for pretty console output.
+ * @module colors
+ */
+
+import chalk from 'chalk';
+
+/**
+ * Color for failure result.
+ * @type {Function}
+ */
+export const failed = chalk.red;
+
+/**
+ * Color for optimal result.
+ * @type {Function}
+ */
+export const optimal = chalk.green;

src/index.js

@@ -0,0 +1,38 @@
+/**
+ * Text reporter.
+ * @module text-reporter
+ */
+
+import createReportSummary from './reporters/report-summary';
+import createGlobalReport from './reporters/report-global';
+import createLocalFilesReport from './reporters/report-local-files';
+import reportWrap from './reporters/report-wrap';
+import computeMetrics from './services/compute-metrics';
+import {
+  areMetricsAboveThresholds,
+  areFilesMetricsAboveThresholds
+} from './services/check-against-thresholds';
+
+/**
+ * Text reporter for esnext-coverage-compatible results.
+ * @param {Object} coverage - esnext-coverage-compatible code coverage.
+ * @param {Object} options - Options.
+ * @param {Object} options.environment - Environment where the tests were run.
+ * @param {Object} options.thresholds - Thresholds for comparison with coverage metrics.
+ * @return {String} Report ready to be written to stdout.
+ */
+module.exports = function textReporter(coverage, options = {}) {
+  const {environment = {}, thresholds = {global: {}, local: {}}} = options;
+  const {projectMetrics, filesMetrics} = computeMetrics(coverage);
+  const isGlobalSuccess = areMetricsAboveThresholds(projectMetrics, thresholds.global);
+  const isLocalSuccess = areFilesMetricsAboveThresholds(filesMetrics, thresholds.local);
+  const isOverallSuccess = isGlobalSuccess && isLocalSuccess;
+  const reportSummary = createReportSummary(isOverallSuccess, environment);
+
+  return reportWrap([
+    reportSummary,
+    createGlobalReport(projectMetrics, thresholds.global),
+    createLocalFilesReport(filesMetrics, thresholds.local),
+    reportSummary
+  ]);
+};

src/reporters/report-global.js

@@ -0,0 +1,16 @@
+/**
+ * Global reporter.
+ * @module reporters/report-global
+ */
+
+import reportUnit from './report-unit';
+
+/**
+ * Creates a global coverage report.
+ * @param {Object} metrics - Global metrics.
+ * @param {Object} thresholds - Global thresholds.
+ * @return {String} Global coverage report as report unit.
+ */
+export default function createGlobalReport(metrics, thresholds) {
+  return reportUnit('Overall project coverage', metrics, thresholds);
+}

src/reporters/report-local-files.js

@@ -0,0 +1,105 @@
+/**
+ * Local files reporter.
+ * @module reporters/report-local-files
+ */
+
+import reportUnit from './report-unit';
+import findCommonPath from '../services/find-common-path';
+import {areMetricsAboveThresholds} from '../services/check-against-thresholds';
+
+/**
+ * File path separator (may differ depending on OS).
+ * @private
+ * @type {RegExp}
+ */
+const separator = /\\|\//;
+
+/**
+ * Normalizes file path separators.
+ * @private
+ * @param {String} path - File path.
+ * @return {String} Normalized file path.
+ * @example
+ *  normalizePath('a\b\c'); // 'a/b/c'
+ */
+function normalizePath(path) {
+  return path.replace(separator, '/');
+}
+
+/**
+ * Creates a failed file reporter function.
+ * @private
+ * @param {Object} localThresholds - Thresholds to be used in the reporter.
+ * @return {Function} Failed file reporter.
+ */
+function failedFileReporterFactory(localThresholds) {
+
+  /**
+   * Failed file reporter.
+   * @private
+   * @param {Object} localReport - Report for a given file.
+   * @param {String} localReport.name - File name.
+   * @param {Object} localReport.metrics - File coverage metrics.
+   * @return {String} Unit report.
+   */
+  return function reportFailedFile({name, metrics}) {
+    return reportUnit(name, metrics, localThresholds);
+  };
+}
+
+/**
+ * Finds and removes the common path from a list of files.
+ * @private
+ * @param {[Object]} failedFiles - List of files.
+ * @return {[Object]} List of files with common path removed.
+ */
+function removeCommonPath(failedFiles) {
+  const filePathList = failedFiles.map(file => file.name);
+  const commonPath = findCommonPath(filePathList);
+  if (!commonPath) { return failedFiles; }
+  return failedFiles.map(file => {
+    file.name = file.name.slice(commonPath.length + 1);
+    return file;
+  });
+}
+
+/**
+ * Finds files that have failed local thresholds.
+ * @private
+ * @param {Object} fileMetricsIndex - Index of file metrics.
+ * @param {Object} thresholds - Local thresholds.
+ * @return {Array} List of files that have failed local thresholds.
+ */
+function findFilesFailingThresholds(fileMetricsIndex, thresholds) {
+  return Object.keys(fileMetricsIndex)
+    .filter(fileName => {
+      const fileMetrics = fileMetricsIndex[fileName];
+      return !areMetricsAboveThresholds(fileMetrics, thresholds);
+    })
+    .map(fileName => {
+      return {
+        name: normalizePath(fileName),
+        metrics: fileMetricsIndex[fileName]
+      };
+    });
+}
+
+/**
+ * Generates a report displaying files that have failed local thresholds.
+ * @param {Object} fileIndex - Index of file metrics.
+ * @param {Object} thresholds - Local thresholds.
+ * @return {String} Failed files report.
+ * @example
+ *  Failed report A
+ *
+ *  Failed report B
+ *
+ *  Failed report C
+ */
+export default function createLocalFilesReport(fileIndex, thresholds) {
+  const failedFiles = findFilesFailingThresholds(fileIndex, thresholds);
+  const failedFileReporter = failedFileReporterFactory(thresholds);
+  return removeCommonPath(failedFiles)
+    .map(failedFileReporter)
+    .join('\n\n');
+}

src/reporters/report-summary.js

@@ -0,0 +1,20 @@
+/**
+ * Report summary.
+ * @module reporters/report-summary
+ */
+
+import {optimal, failed} from '../colors';
+
+/**
+ * Generates the overall report summary.
+ * @param  {Boolean} isSuccess   Indicator of coverage matching threshold limits.
+ * @param  {Object}  environment The environment where the test was run.
+ * @return {String} Report summary.
+ * @example
+ *  Failed test coverage on Node v5.4.0
+ */
+export default function createReportSummary(isSuccess, environment) {
+  const overallResultMessage = isSuccess ? optimal('Passed') : failed('Failed');
+  const envName = environment.name || `Node ${process.version}`;
+  return `${overallResultMessage} test coverage on ${envName}`;
+}