eslint-teamcity - npm Package Compare versions

Comparing version 1.3.1 to 1.4.0

index.js

@@ -0,3 +1,21 @@
+#!/usr/bin/env node
+
 'use strict';
+var fs = require('fs-extra'),
+  procArg = process.argv;
 
-module.exports = require('./src/formatter');
+if (require.main === module) {
+  process.stdout.write(main(fs.readJSONSync(procArg[2])))
+} else {
+  module.exports = main;
+}
+
+/**
+ * main function
+ * @param {String} input - input data stringify json
+ * @param {Object} [teamcityPropNames] - names of the vars
+ * @returns {String} format result
+ */
+function main(input, teamcityPropNames) {
+  return require('./src/formatter')(input, teamcityPropNames);
+}

package.json

 {
   "name": "eslint-teamcity",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "An ESLint formatter plugin for TeamCity",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha ./test/",
-    "test-travis": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec ./test/*"
+    "test": "./node_modules/mocha/bin/mocha ./test/*.spec.js",
+    "test-travis": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec ./test/*.spec.js"
   },
@@ -17,5 +17,6 @@ "repository": {
     "teamcity",
-    "formatter"
+    "formatter",
+    "linting"
   ],
-  "author": "Andre Ogle <[e-mail]> (https://github.com/andreogle)",
+  "author": "Andre Ogle <[e-mail]> (https://github.com/andreogle)",
   "license": "MIT",
@@ -27,8 +28,12 @@ "bugs": {
     "chai": "^3.5.0",
-    "coveralls": "^2.11.8",
-    "eslint": "^3.8.1",
-    "istanbul": "^0.4.2",
-    "mocha": "^2.4.5",
-    "sinon": "^1.17.6"
+    "coveralls": "^2.12.0",
+    "eslint": "^3.18.0",
+    "istanbul": "^0.4.5",
+    "mocha": "^3.2.0",
+    "shelljs": "^0.7.8",
+    "sinon": "^2.1.0"
+  },
+  "dependencies": {
+    "fs-extra": "^3.0.1"
   }
 }

README.md

@@ -10,7 +10,7 @@ # eslint-teamcity
 [TeamCity](https://www.jetbrains.com/teamcity/) build error format. Tested with
-TeamCity 9.1.x/10.0.x and ESLint 1/2/3.
+TeamCity 9.1.x/10.0.x/2017 and ESLint 1/2/3/4.
 
 ## Installation
 
-[Use npm](https://docs.npmjs.com/cli/install).
+Prerequisite: You must have either [npm](https://docs.npmjs.com/cli/install) or [Yarn](https://yarnpkg.com/en/docs/install) installed.
 
@@ -22,17 +22,35 @@ ```sh
 ## Usage
+There are currently 3 ways to use eslint-teamcity:
+##### As a regular ESLint formatter plugin:
 ```sh
-  eslint --format './node_modules/eslint-teamcity/index.js' myfiletolint.js
+eslint --format ./node_modules/eslint-teamcity/index.js myfiletolint.js
 ```
 
+##### Running against a generated ESLint JSON report:
+Generate an ESLint JSON report:
+```sh
+eslint -f json -o result.json app/myjavascriptdirectory
+```
+Run eslint-teamcity against the new report:
+```sh
+node ./node_modules/eslint-teamcity/index.js result.json
+```
+
+##### Requiring and running directly from inside your JavaScript code:
+```javascript
+var eslintTeamcity = require('eslint-teamcity');
+console.log(eslintTeamcity(result));
+```
+
 ## [gulp-eslint](https://github.com/adametry/gulp-eslint) integration
 ```javascript
-var gulp = require('gulp'),
-    eslint = require('gulp-eslint'),
-    teamcity = require('eslint-teamcity');
+var gulp = require('gulp');
+var eslint = require('gulp-eslint');
+var teamcity = require('eslint-teamcity');
 
 gulp.task('lint', function () {
-    return gulp.src(['js/**/*.js'])
-        .pipe(eslint())
-        .pipe(eslint.format(teamcity))
-        .pipe(eslint.failAfterError());
+  return gulp.src(['js/**/*.js'])
+    .pipe(eslint())
+    .pipe(eslint.format(teamcity))
+    .pipe(eslint.failAfterError());
 });
@@ -39,0 +57,0 @@ ```

src/formatter.js

@@ -35,12 +35,18 @@ /**
 
-var reportName = 'ESLint Violations';
-
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
-module.exports = function(results) {
+module.exports = function(results, teamcityPropNames) {
   var output = '';
   var errorCount = 0;
   var warningCount = 0;
+  var reportName;
+  var errorCountName;
+  var warningCountName;
+  var varNames = teamcityPropNames || {};
 
+  reportName = varNames.reportName || 'ESLint Violations';
+  errorCountName = varNames.errorCountName || 'ESLintErrorCount';
+  warningCountName = varNames.warningCountName || 'ESLintWarningCount';
+
   output += '##teamcity[testSuiteStarted name=\'' + reportName + '\']\n';
@@ -90,6 +96,6 @@
 
-  output += '##teamcity[buildStatisticValue key=\'ESLintErrorCount\' value=\'' + errorCount +'\' ]\n';
-  output += '##teamcity[buildStatisticValue key=\'ESLintWarningCount\' value=\'' + warningCount +'\' ]\n';
+  output += '##teamcity[buildStatisticValue key=\'' + errorCountName + '\' value=\'' + errorCount +'\' ]\n';
+  output += '##teamcity[buildStatisticValue key=\'' + warningCountName + '\' value=\'' + warningCount +'\' ]\n';
 
   return output;
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16395

increased by25.03%

Number of package files

11

increased by22.22%

Lines of code

310

increased by27.57%

Number of lines in readme file

85

increased by26.87%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

7

increased by16.67%

Number of low supply chain risk alerts

4

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedfs-extra@^3.0.1

• + Addedfs-extra@3.0.1(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedjsonfile@3.0.1(transitive)

• + Addeduniversalify@0.1.2(transitive)