Merged release/3.1.0 into master

groupe-sii · Dec 19, 2016 · f04e57f · f04e57f
2 parents c4d8390 + da57179
commit f04e57f
Show file tree

Hide file tree

Showing 49 changed files with 512 additions and 139 deletions.
diff --git a/.sreporterrc b/.sreporterrc
@@ -6,7 +6,7 @@
      "rulesFile": "./samples/.csslintrc"
    },
   "eslint": {
-    "src": "./samples/src/**/*.js",
+    "src": [ "samples/src/**/*.js", "!samples/src/bower_components/**" ],
     "report": "reports/sonar/eslint.json",
     "rulesFile": "./samples/.eslintrc"
   },

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,47 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) 
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+
+## 3.1.0 - 2016-12-19
+
+### Added
+
+- **multi-glob**: The `src` property can now take an array of globs (Closes [#15](https://github.com/groupe-sii/sonar-web-frontend-reporters/issues/15)) [@ValentinGot]
+- **cli**: Add command line usage and version number [@ValentinGot]
+
+### Fixed
+
+- **es5**: The `.ES5.*` require method couldn't work, documentation has been updated accordingly [@ValentinGot]
+- **es5**: `arr.includes()` method isn't available on ES5 (Closes [#14](https://github.com/groupe-sii/sonar-web-frontend-reporters/issues/14)) [@ValentinGot]
+- **eslint**: use the `severity` property to retrieve the severity (Closes [#16](https://github.com/groupe-sii/sonar-web-frontend-reporters/issues/16)) [@ValentinGot]
+- **eslint-angular**: use the `severity` property to retrieve the severity (Closes [#16](https://github.com/groupe-sii/sonar-web-frontend-reporters/issues/16)) [@ValentinGot]
+
+## 3.0.0 - 2016-12-09
+
+- Release first stable version
+
+## 3.0.0-beta2 - 2016-12-07
+
+- Add ES5 backward compatibility (Closes #13)
+
+## 3.0.0-beta - 2016-12-05
+
+### Added
+
+- Full ES6
+- Command-Line Interface
+- Usable in NodeJS
+- Refactored all reporters
+- Contribution guide
+
+### Removed
+
+- Gulp abstraction
+
+[@ole]: https://github.com/liollury
+[@ValentinGot]: https://github.com/ValentinGot
diff --git a/README.md b/README.md
@@ -152,8 +152,8 @@ cssLintReporter.launch(() => {
 To use it with older NodeJS versions, you can require the reporters this way:
 
 ```js
-const SonarWebReporters = require('sonar-web-frontend-reporters').ES5.Reporters;
-const CSSLintReporter = require('sonar-web-frontend-reporters').ES5.CSSLintReporter;
+var SonarWebReporters = require('sonar-web-frontend-reporters/build/reporters');
+var CSSLintReporter = require('sonar-web-frontend-reporters/build/reporters/csslint.reporter');
 ```
 
 ## Available reporters

diff --git a/bin/sreporter b/bin/sreporter
@@ -4,21 +4,29 @@
 
 var chalk = require('chalk'),
   version = require('../package.json').version,
-  es5 = (process.argv.includes('--es5') > -1),
+  program = require('commander'),
   CLIEngine;
 
-// Use ES5 backward compatibility ?
-if (es5) {
-  CLIEngine = require('../build/cli');
-} else {
-  CLIEngine = require('../lib/cli');
-}
-
-// Log version number
-if (process.argv.includes('version') || process.argv.includes('--version')) {
-  console.info(chalk.bold('sreporter version v' + version));
-  process.exit(0);
-}
-
-var cli = new CLIEngine();
-cli.launchReporters();
+var CLI = {
+
+  /**
+   * Launch reporters
+   */
+  launchReporters: function () {
+    if (program.es5) {
+      CLIEngine = require('../build/cli');
+    } else {
+      CLIEngine = require('../lib/cli');
+    }
+
+    (new CLIEngine()).launchReporters();
+  }
+
+};
+
+program
+  .version(version)
+  .option('--es5', 'launch CLI with ES5 backward compatibility')
+  .parse(process.argv);
+
+CLI.launchReporters();
diff --git a/build/api.js b/build/api.js
@@ -9,16 +9,5 @@ module.exports = {
   JSHintReporter: require('./reporters/jshint.reporter'),
   TSLintReporter: require('./reporters/tslint.reporter'),
   SASSLintReporter: require('./reporters/sasslint.reporter'),
-  SASSToSCSSLintReporter: require('./reporters/sass-to-scsslint.reporter'),
-  ES5: {
-    Reporters: require('../build/reporters'),
-    CSSLintReporter: require('../build/reporters/csslint.reporter'),
-    ESLintReporter: require('../build/reporters/eslint.reporter'),
-    ESLintAngularReporter: require('../build/reporters/eslint-angular.reporter'),
-    HTMLHintReporter: require('../build/reporters/htmlhint.reporter'),
-    JSHintReporter: require('../build/reporters/jshint.reporter'),
-    TSLintReporter: require('../build/reporters/tslint.reporter'),
-    SASSLintReporter: require('../build/reporters/sasslint.reporter'),
-    SASSToSCSSLintReporter: require('../build/reporters/sass-to-scsslint.reporter')
-  }
+  SASSToSCSSLintReporter: require('./reporters/sass-to-scsslint.reporter')
 };
diff --git a/build/reporters/csslint.reporter.js b/build/reporters/csslint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     csslint = require('csslint').CSSLint,
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');

diff --git a/build/reporters/eslint-angular.reporter.js b/build/reporters/eslint-angular.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     CLIEngine = require('eslint').CLIEngine,
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');

diff --git a/build/reporters/eslint.reporter.js b/build/reporters/eslint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     CLIEngine = require('eslint').CLIEngine,
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');
@@ -34,7 +34,7 @@ module.exports = function (_Reporter) {
         configFile: this.options.rulesFile
       });
 
-      glob(this.options.src, function (er, files) {
+      glob(this.options.src, function (err, files) {
         _this2.processFiles(files, _this2.options);
         _this2.closeReporter(_this2.options.report);
 

diff --git a/build/reporters/htmlhint.reporter.js b/build/reporters/htmlhint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     HTMLHint = require('htmlhint').HTMLHint,
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');

diff --git a/build/reporters/jshint.reporter.js b/build/reporters/jshint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     jshintcli = require('jshint/src/cli'),
     jshint = require('jshint').JSHINT,
     ReporterType = require('../reporter.enum'),

diff --git a/build/reporters/sass-to-scsslint.reporter.js b/build/reporters/sass-to-scsslint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     sasslint = require('sass-lint'),
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter'),

diff --git a/build/reporters/sasslint.reporter.js b/build/reporters/sasslint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     sasslint = require('sass-lint'),
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');

diff --git a/build/reporters/tslint.reporter.js b/build/reporters/tslint.reporter.js
@@ -8,7 +8,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var glob = require('glob'),
+var glob = require('glob-all'),
     TSLint = require('tslint'),
     ReporterType = require('../reporter.enum'),
     Reporter = require('../reporter');

diff --git a/lib/api.js b/lib/api.js
@@ -7,16 +7,5 @@ module.exports = {
   JSHintReporter        : require('./reporters/jshint.reporter'),
   TSLintReporter        : require('./reporters/tslint.reporter'),
   SASSLintReporter      : require('./reporters/sasslint.reporter'),
-  SASSToSCSSLintReporter: require('./reporters/sass-to-scsslint.reporter'),
-  ES5                   : {
-    Reporters             : require('../build/reporters'),
-    CSSLintReporter       : require('../build/reporters/csslint.reporter'),
-    ESLintReporter        : require('../build/reporters/eslint.reporter'),
-    ESLintAngularReporter : require('../build/reporters/eslint-angular.reporter'),
-    HTMLHintReporter      : require('../build/reporters/htmlhint.reporter'),
-    JSHintReporter        : require('../build/reporters/jshint.reporter'),
-    TSLintReporter        : require('../build/reporters/tslint.reporter'),
-    SASSLintReporter      : require('../build/reporters/sasslint.reporter'),
-    SASSToSCSSLintReporter: require('../build/reporters/sass-to-scsslint.reporter')
-  }
+  SASSToSCSSLintReporter: require('./reporters/sass-to-scsslint.reporter')
 };
diff --git a/lib/reporters/csslint.reporter.js b/lib/reporters/csslint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   csslint = require('csslint').CSSLint,
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');

diff --git a/lib/reporters/eslint-angular.reporter.js b/lib/reporters/eslint-angular.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   CLIEngine = require('eslint').CLIEngine,
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');
@@ -48,7 +48,7 @@ module.exports = class ESLintAngularReporter extends Reporter {
 
     this.openFileIssues(file, null, /^(\s+)?\n$/gm);
     for (let message of result.results[0].messages) {
-      switch (message.type) {
+      switch (message.severity) {
         case 2:
           severity = this.MAJOR;
           break;

diff --git a/lib/reporters/eslint.reporter.js b/lib/reporters/eslint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   CLIEngine = require('eslint').CLIEngine,
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');
@@ -24,7 +24,7 @@ module.exports = class ESLintReporter extends Reporter {
       configFile: this.options.rulesFile
     });
 
-    glob(this.options.src, (er, files) => {
+    glob(this.options.src, (err, files) => {
       this.processFiles(files, this.options);
       this.closeReporter(this.options.report);
 
@@ -48,7 +48,7 @@ module.exports = class ESLintReporter extends Reporter {
 
     this.openFileIssues(file, null, /^(\s+)?\n$/gm);
     for (let message of result.results[0].messages) {
-      switch (message.type) {
+      switch (message.severity) {
         case 2:
           severity = this.MAJOR;
           break;

diff --git a/lib/reporters/htmlhint.reporter.js b/lib/reporters/htmlhint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   HTMLHint = require('htmlhint').HTMLHint,
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');

diff --git a/lib/reporters/jshint.reporter.js b/lib/reporters/jshint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   jshintcli = require('jshint/src/cli'),
   jshint = require('jshint').JSHINT,
   ReporterType = require('../reporter.enum'),

diff --git a/lib/reporters/sass-to-scsslint.reporter.js b/lib/reporters/sass-to-scsslint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   sasslint = require('sass-lint'),
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter'),

diff --git a/lib/reporters/sasslint.reporter.js b/lib/reporters/sasslint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   sasslint = require('sass-lint'),
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');

diff --git a/lib/reporters/tslint.reporter.js b/lib/reporters/tslint.reporter.js
@@ -1,4 +1,4 @@
-const glob = require('glob'),
+const glob = require('glob-all'),
   TSLint = require('tslint'),
   ReporterType = require('../reporter.enum'),
   Reporter = require('../reporter');

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "sonar-web-frontend-reporters",
-  "description": "This is a repo of SII continuous integration build system dedicated to Front-end webapps. This repo provides all the reporters written by SII for the generic [Sonarqube plugin](https://github.com/groupe-sii/sonar-web-client-plugin)",
-  "version": "3.0.0",
+  "description": "sreporter is a Command-Line Interface to generate Front-End linters reporters for the SonarQube plugin",
+  "version": "3.1.0",
   "main": "./lib/api.js",
   "bin": {
     "sreporter": "./bin/sreporter"
@@ -22,6 +22,8 @@
     "csslint",
     "htmlhint",
     "eslint",
+    "angularjs",
+    "tslint",
     "sonar"
   ],
   "author": "Cédric Le Gallo <[email protected]> (http://www.groupe-sii.com/)",
@@ -37,11 +39,13 @@
   "homepage": "https://github.com/groupe-sii/sonar-web-frontend-reporters#readme",
   "dependencies": {
     "chalk": "^1.1.3",
+    "commander": "^2.9.0",
     "csslint": "^1.0.4",
     "eslint": "^3.11.1",
     "eslint-config-angular": "^0.5.0",
     "eslint-plugin-angular": "^1.4.1",
     "glob": "^7.1.1",
+    "glob-all": "^3.1.0",
     "htmlhint": "^0.9.13",
     "jshint": "^2.9.4",
     "mkdirp": "^0.5.1",

diff --git a/samples/src/bower_components/test.js b/samples/src/bower_components/test.js
@@ -0,0 +1 @@
+var bower = 'bower';
diff --git a/samples/src/nodejs.es5.js b/samples/src/nodejs.es5.js
@@ -0,0 +1,28 @@
+var SonarWebReporters = require('../../build/reporters');
+
+var sonarWebReporters = new SonarWebReporters('Sonar Web Reporters', {
+  "csslint": false,
+  "eslint": {
+    "src": "samples/src/**/*.js",
+    "report": "reports/sonar/eslint.json",
+    "rulesFile": "./samples/.eslintrc"
+  },
+  "eslintangular": {
+    "src": "samples/src/**/*.js",
+    "report": "reports/sonar/eslint-angular.json",
+    "rulesFile": "./samples/.eslintangularrc"
+  },
+  "jshint": {
+    "src": "samples/src/**/*.js",
+    "report": "reports/sonar/jshint.json",
+    "rulesFile": "./samples/.jshintrc"
+  },
+  "htmlhint": {
+    "src": "samples/src/**/*.html",
+    "report": "reports/sonar/htmlhint.json",
+    "rulesFile": "./samples/.htmlhintrc"
+  }
+});
+sonarWebReporters.launchReporters(function () {
+  console.log('All reporters have been processed');
+});
diff --git a/samples/src/nodejs.js b/samples/src/nodejs.js
@@ -1,4 +1,4 @@
-const SonarWebReporters = require('../../index').Reporters;
+const SonarWebReporters = require('../../lib/api').Reporters;
 
 let sonarWebReporters = new SonarWebReporters('Sonar Web Reporters', {
   "csslint": false,
@@ -9,7 +9,7 @@ let sonarWebReporters = new SonarWebReporters('Sonar Web Reporters', {
   },
   "eslintangular": {
     "src": "samples/src/**/*.js",
-    "report": "reports/sonar/eslintangular.json",
+    "report": "reports/sonar/eslint-angular.json",
     "rulesFile": "./samples/.eslintangularrc"
   },
   "jshint": {