eslint-plugin-sonarjs 0.4.0 → 0.7.0

package/.cirrus/nodejs-10.Dockerfile

@@ -0,0 +1,29 @@
+FROM gcr.io/language-team/base:latest
+
+USER root
+
+ENV NODE_VERSION v10.23.2
+
+RUN  wget -U "nodejs" -q -O nodejs.tar.xz https://nodejs.org/dist/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64.tar.xz \
+    && tar -xJf "nodejs.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+    && rm nodejs.tar.xz \
+    && ln -s /usr/local/bin/node /usr/local/bin/nodejs
+
+ENV YARN_VERSION 1.22.5
+
+RUN curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
+      && mkdir -p /opt \
+      && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
+      && rm yarn-v$YARN_VERSION.tar.gz
+
+RUN curl "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.3.0.2102.zip" -o /tmp/sonar-scanner.zip \
+  && unzip -d /opt /tmp/sonar-scanner.zip \
+  && mv /opt/sonar-scanner-4.3.0.2102 /opt/sonar-scanner \
+  && rm /tmp/sonar-scanner.zip
+
+USER sonarsource
+
+ENV PATH "/opt/sonar-scanner/bin:${PATH}"
+ENV SONARCLOUD_ANALYSIS true

package/.cirrus/nodejs-12.Dockerfile

@@ -0,0 +1,28 @@
+FROM gcr.io/language-team/base:latest
+
+USER root
+
+ENV NODE_VERSION v12.20.1
+
+RUN  wget -U "nodejs" -q -O nodejs.tar.xz https://nodejs.org/dist/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64.tar.xz \
+    && tar -xJf "nodejs.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+    && rm nodejs.tar.xz \
+    && ln -s /usr/local/bin/node /usr/local/bin/nodejs
+
+ENV YARN_VERSION 1.22.5
+
+RUN curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
+      && mkdir -p /opt \
+      && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
+      && rm yarn-v$YARN_VERSION.tar.gz
+
+RUN curl "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.3.0.2102.zip" -o /tmp/sonar-scanner.zip \
+  && unzip -d /opt /tmp/sonar-scanner.zip \
+  && mv /opt/sonar-scanner-4.3.0.2102 /opt/sonar-scanner \
+  && rm /tmp/sonar-scanner.zip
+
+USER sonarsource
+
+ENV PATH "/opt/sonar-scanner/bin:${PATH}"

package/.cirrus/nodejs-14.Dockerfile

@@ -0,0 +1,28 @@
+FROM gcr.io/language-team/base:latest
+
+USER root
+
+ENV NODE_VERSION v14.15.4
+
+RUN  wget -U "nodejs" -q -O nodejs.tar.xz https://nodejs.org/dist/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64.tar.xz \
+    && tar -xJf "nodejs.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+    && rm nodejs.tar.xz \
+    && ln -s /usr/local/bin/node /usr/local/bin/nodejs
+
+ENV YARN_VERSION 1.22.5
+
+RUN curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
+      && mkdir -p /opt \
+      && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
+      && rm yarn-v$YARN_VERSION.tar.gz
+
+RUN curl "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.3.0.2102.zip" -o /tmp/sonar-scanner.zip \
+  && unzip -d /opt /tmp/sonar-scanner.zip \
+  && mv /opt/sonar-scanner-4.3.0.2102 /opt/sonar-scanner \
+  && rm /tmp/sonar-scanner.zip
+
+USER sonarsource
+
+ENV PATH "/opt/sonar-scanner/bin:${PATH}"

package/.cirrus/nodejs-15.Dockerfile

@@ -0,0 +1,28 @@
+FROM gcr.io/language-team/base:latest
+
+USER root
+
+ENV NODE_VERSION v15.10.0
+
+RUN  wget -U "nodejs" -q -O nodejs.tar.xz https://nodejs.org/dist/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64.tar.xz \
+    && tar -xJf "nodejs.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+    && rm nodejs.tar.xz \
+    && ln -s /usr/local/bin/node /usr/local/bin/nodejs
+
+ENV YARN_VERSION 1.22.5
+
+RUN curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
+      && mkdir -p /opt \
+      && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
+      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
+      && rm yarn-v$YARN_VERSION.tar.gz
+
+RUN curl "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.3.0.2102.zip" -o /tmp/sonar-scanner.zip \
+  && unzip -d /opt /tmp/sonar-scanner.zip \
+  && mv /opt/sonar-scanner-4.3.0.2102 /opt/sonar-scanner \
+  && rm /tmp/sonar-scanner.zip
+
+USER sonarsource
+
+ENV PATH "/opt/sonar-scanner/bin:${PATH}"

package/.cirrus.yml

@@ -0,0 +1,47 @@
+gcp_credentials: ENCRYPTED[!17c59813193e86cc337bce848b358412b90f50bc5fe1b8b39d363cdf14a41ebe76cfba0482e7f81d076994b9f6dbfb4c!]
+
+env:
+  GITHUB_TOKEN: ENCRYPTED[!f272985ea5b49b3cf9c414b98de6a8e9096be47bfcee52f33311ba3131a2af637c1b956f49585b7757dd84b7c030233a!]
+  SONAR_TOKEN: ENCRYPTED[!4e5894b7b32f763db69e70fb56188d3f42539db36374b1f97c425f37a7ecd441c28a9da267c461b9cc8fb53124f14c22!]
+  NPM_DEPLOYER_AUTH: ENCRYPTED[!f4021c529fe14ea134a81e2a147782f095a68c3805328c09409e06e229f66e7fbe742e1b3c522a0cdc2187e730de3814!]
+  # Use bash (instead of sh on linux or cmd.exe on windows)
+  CIRRUS_SHELL: bash
+
+only_sonarsource_qa: &ONLY_SONARSOURCE_QA
+  only_if: $CIRRUS_USER_COLLABORATOR == 'true' && ($CIRRUS_PR != "" || $CIRRUS_BRANCH == "master" || $CIRRUS_BRANCH =~ "branch-.*" || $CIRRUS_BRANCH =~ "dogfood-on-.*")
+
+container_definition: &CONTAINER_DEFINITION
+  builder_image_project: language-team
+  builder_image_name: docker-builder-lt-v1
+  cluster_name: cirrus-ci-lt-cluster
+  zone: us-central1-a
+  namespace: default
+  use_in_memory_disk: true
+
+plugin_qa_task:
+  <<: *ONLY_SONARSOURCE_QA
+  gke_container:
+    matrix:
+      - dockerfile: .cirrus/nodejs-10.Dockerfile
+      - dockerfile: .cirrus/nodejs-12.Dockerfile
+      - dockerfile: .cirrus/nodejs-14.Dockerfile
+      - dockerfile: .cirrus/nodejs-15.Dockerfile
+    <<: *CONTAINER_DEFINITION
+    cpu: 3
+    memory: 8G
+  env:
+    CIRRUS_CLONE_DEPTH: 10
+    SONARSOURCE_QA: true
+  npmrc_file:
+    path: ${HOME}/.npmrc
+    variable_name: NPM_DEPLOYER_AUTH
+  script:
+    - init_git_submodules -r
+    - yarn
+    - yarn typecheck
+    - yarn build
+    - ./scripts/test-ci.sh
+    - yarn prettier --list-different "{src,tests}/**/*.{js,ts}"
+    - yarn lint
+    - yarn ruling
+    - ./scripts/analyze_and_publish.sh

package/.eslintignore

@@ -0,0 +1 @@
+tests/resources

package/README.md

@@ -1,9 +1,7 @@
-# eslint-plugin-sonarjs [![npm version](https://badge.fury.io/js/eslint-plugin-sonarjs.svg)](https://badge.fury.io/js/eslint-plugin-sonarjs) [![Build Status](https://travis-ci.org/SonarSource/eslint-plugin-sonarjs.svg?branch=master)](https://travis-ci.org/SonarSource/eslint-plugin-sonarjs) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=eslint-plugin-sonarjs&metric=alert_status)](https://sonarcloud.io/dashboard?id=eslint-plugin-sonarjs) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=eslint-plugin-sonarjs&metric=coverage)](https://sonarcloud.io/dashboard?id=eslint-plugin-sonarjs)
+# eslint-plugin-sonarjs [![npm version](https://badge.fury.io/js/eslint-plugin-sonarjs.svg)](https://badge.fury.io/js/eslint-plugin-sonarjs) [![Build Status](https://api.cirrus-ci.com/github/SonarSource/eslint-plugin-sonarjs.svg?branch=master)](https://cirrus-ci.com/github/SonarSource/eslint-plugin-sonarjs) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=eslint-plugin-sonarjs&metric=alert_status)](https://sonarcloud.io/dashboard?id=eslint-plugin-sonarjs) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=eslint-plugin-sonarjs&metric=coverage)](https://sonarcloud.io/dashboard?id=eslint-plugin-sonarjs)
 
 SonarJS rules for ESLint to detect bugs and suspicious patterns in your code.
 
-_[We also have a plugin for TSLint](https://github.com/SonarSource/SonarTS)_
-
 ## Rules
 
 ### Bug Detection :bug:
@@ -25,22 +23,27 @@ Code Smells, or maintainability issues, are raised for places of code which migh
 * Cognitive Complexity of functions should not be too high ([`cognitive-complexity`])
 * "switch" statements should not have too many "case" clauses ([`max-switch-cases`])
 * Collapsible "if" statements should be merged ([`no-collapsible-if`])
+* Collection sizes and array length comparisons should make sense ([`no-collection-size-mischeck`])
 * String literals should not be duplicated ([`no-duplicate-string`])
 * Two branches in a conditional structure should not have exactly the same implementation ([`no-duplicated-branches`])
 * Functions should not have identical implementations ([`no-identical-functions`])
-* Boolean checks should not be inverted ([`no-inverted-boolean-check`])
+* Boolean checks should not be inverted ([`no-inverted-boolean-check`]) (:wrench: *fixable*)
 * Boolean literals should not be redundant ([`no-redundant-boolean`])
+* Jump statements should not be redundant ([`no-redundant-jump`])
+* Conditionals should start on new lines ([`no-same-line-conditional`])
 * "switch" statements should have at least 3 "case" clauses ([`no-small-switch`])
+* Collection and array contents should be used ([`no-unused-collection`])
 * "catch" clauses should do more than rethrow ([`no-useless-catch`])
 * Local variables should not be declared and then immediately returned or thrown ([`prefer-immediate-return`]) (:wrench: *fixable*)
 * Object literal syntax should be used ([`prefer-object-literal`])
 * Return of boolean expressions should not be wrapped into an "if-then-else" statement ([`prefer-single-boolean-return`])
-* A "while" loop should be used instead of a "for" loop ([`prefer-while`]) (:wrench: *fixable*) 
+* A "while" loop should be used instead of a "for" loop ([`prefer-while`]) (:wrench: *fixable*)
 
 [`cognitive-complexity`]: ./docs/rules/cognitive-complexity.md
 [`max-switch-cases`]: ./docs/rules/max-switch-cases.md
 [`no-all-duplicated-branches`]: ./docs/rules/no-all-duplicated-branches.md
 [`no-collapsible-if`]: ./docs/rules/no-collapsible-if.md
+[`no-collection-size-mischeck`]: ./docs/rules/no-collection-size-mischeck.md
 [`no-duplicate-string`]: ./docs/rules/no-duplicate-string.md
 [`no-duplicated-branches`]: ./docs/rules/no-duplicated-branches.md
 [`no-element-overwrite`]: ./docs/rules/no-element-overwrite.md
@@ -51,8 +54,11 @@ Code Smells, or maintainability issues, are raised for places of code which migh
 [`no-inverted-boolean-check`]: ./docs/rules/no-inverted-boolean-check.md
 [`no-one-iteration-loop`]: ./docs/rules/no-one-iteration-loop.md
 [`no-redundant-boolean`]: ./docs/rules/no-redundant-boolean.md
+[`no-redundant-jump`]: ./docs/rules/no-redundant-jump.md
+[`no-same-line-conditional`]: ./docs/rules/no-same-line-conditional.md
 [`no-small-switch`]: ./docs/rules/no-small-switch.md
 [`no-use-of-empty-return-value`]: ./docs/rules/no-use-of-empty-return-value.md
+[`no-unused-collection`]: ./docs/rules/no-unused-collection.md
 [`no-useless-catch`]: ./docs/rules/no-useless-catch.md
 [`prefer-immediate-return`]: ./docs/rules/prefer-immediate-return.md
 [`prefer-object-literal`]: ./docs/rules/prefer-object-literal.md
@@ -61,7 +67,7 @@ Code Smells, or maintainability issues, are raised for places of code which migh
 
 ## Prerequisites
 
-Node.js (>=6.x).
+Node.js (>=10.x).
 
 ## Usage
 
@@ -91,12 +97,12 @@ npm install eslint-plugin-sonarjs -g         # or install globally
 
 * or enable only some rules manually:
 
-```json
+```javascript
 {
   "rules": {
     "sonarjs/cognitive-complexity": "error",
     "sonarjs/no-identical-expressions": "error"
-    // etc
+    // etc.
   }
 }
 ```

package/lib/index.d.ts

@@ -1,6 +1,8 @@
 import { Linter } from "eslint";
 declare const sonarjsRuleModules: any;
 declare const configs: {
-    recommended: Linter.Config;
+    recommended: Linter.Config & {
+        plugins: string[];
+    };
 };
 export { sonarjsRuleModules as rules, configs };

package/lib/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var sonarjsRules = [
+exports.configs = exports.rules = void 0;
+const sonarjsRules = [
     ["cognitive-complexity", "error"],
     ["max-switch-cases", "error"],
     ["no-all-duplicated-branches", "error"],
     ["no-collapsible-if", "error"],
+    ["no-collection-size-mischeck", "error"],
     ["no-duplicate-string", "error"],
     ["no-duplicated-branches", "error"],
     ["no-element-overwrite", "error"],
@@ -15,7 +17,10 @@ var sonarjsRules = [
     ["no-inverted-boolean-check", "error"],
     ["no-one-iteration-loop", "error"],
     ["no-redundant-boolean", "error"],
+    ["no-redundant-jump", "error"],
+    ["no-same-line-conditional", "error"],
     ["no-small-switch", "error"],
+    ["no-unused-collection", "error"],
     ["no-use-of-empty-return-value", "error"],
     ["no-useless-catch", "error"],
     ["prefer-immediate-return", "error"],
@@ -23,12 +28,12 @@ var sonarjsRules = [
     ["prefer-single-boolean-return", "error"],
     ["prefer-while", "error"],
 ];
-var sonarjsRuleModules = {};
+const sonarjsRuleModules = {};
 exports.rules = sonarjsRuleModules;
-var configs = {
-    recommended: { rules: {} },
+const configs = {
+    recommended: { plugins: ["sonarjs"], rules: {} },
 };
 exports.configs = configs;
-sonarjsRules.forEach(function (rule) { return (sonarjsRuleModules[rule[0]] = require("./rules/" + rule[0])); });
-sonarjsRules.forEach(function (rule) { return (configs.recommended.rules["sonarjs/" + rule[0]] = rule[1]); });
+sonarjsRules.forEach(rule => (sonarjsRuleModules[rule[0]] = require(`./rules/${rule[0]}`)));
+sonarjsRules.forEach(rule => (configs.recommended.rules[`sonarjs/${rule[0]}`] = rule[1]));
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAqBA,IAAM,YAAY,GAAiC;IACjD,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAC7B,CAAC,4BAA4B,EAAE,OAAO,CAAC;IACvC,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAC9B,CAAC,qBAAqB,EAAE,OAAO,CAAC;IAChC,CAAC,wBAAwB,EAAE,OAAO,CAAC;IACnC,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAC/B,CAAC,yBAAyB,EAAE,OAAO,CAAC;IACpC,CAAC,wBAAwB,EAAE,OAAO,CAAC;IACnC,CAAC,0BAA0B,EAAE,OAAO,CAAC;IACrC,CAAC,2BAA2B,EAAE,OAAO,CAAC;IACtC,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAClC,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,iBAAiB,EAAE,OAAO,CAAC;IAC5B,CAAC,8BAA8B,EAAE,OAAO,CAAC;IACzC,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAC7B,CAAC,yBAAyB,EAAE,OAAO,CAAC;IACpC,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAClC,CAAC,8BAA8B,EAAE,OAAO,CAAC;IACzC,CAAC,cAAc,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,IAAM,kBAAkB,GAAQ,EAAE,CAAC;AASJ,mCAAK;AAPpC,IAAM,OAAO,GAAmC;IAC9C,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;CAC3B,CAAC;AAKoC,0BAAO;AAH7C,YAAY,CAAC,OAAO,CAAC,UAAA,IAAI,IAAI,OAAA,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAW,IAAI,CAAC,CAAC,CAAG,CAAC,CAAC,EAA7D,CAA6D,CAAC,CAAC;AAC5F,YAAY,CAAC,OAAO,CAAC,UAAA,IAAI,IAAI,OAAA,CAAC,OAAO,CAAC,WAAW,CAAC,KAAM,CAAC,aAAW,IAAI,CAAC,CAAC,CAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,EAA5D,CAA4D,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAqBA,MAAM,YAAY,GAAiC;IACjD,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAC7B,CAAC,4BAA4B,EAAE,OAAO,CAAC;IACvC,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAC9B,CAAC,6BAA6B,EAAE,OAAO,CAAC;IACxC,CAAC,qBAAqB,EAAE,OAAO,CAAC;IAChC,CAAC,wBAAwB,EAAE,OAAO,CAAC;IACnC,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAC/B,CAAC,yBAAyB,EAAE,OAAO,CAAC;IACpC,CAAC,wBAAwB,EAAE,OAAO,CAAC;IACnC,CAAC,0BAA0B,EAAE,OAAO,CAAC;IACrC,CAAC,2BAA2B,EAAE,OAAO,CAAC;IACtC,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAClC,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAC9B,CAAC,0BAA0B,EAAE,OAAO,CAAC;IACrC,CAAC,iBAAiB,EAAE,OAAO,CAAC;IAC5B,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACjC,CAAC,8BAA8B,EAAE,OAAO,CAAC;IACzC,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAC7B,CAAC,yBAAyB,EAAE,OAAO,CAAC;IACpC,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAClC,CAAC,8BAA8B,EAAE,OAAO,CAAC;IACzC,CAAC,cAAc,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,kBAAkB,GAAQ,EAAE,CAAC;AASJ,mCAAK;AAPpC,MAAM,OAAO,GAA2D;IACtE,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;CACjD,CAAC;AAKoC,0BAAO;AAH7C,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5F,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,KAAM,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/lib/rules/cognitive-complexity.js

@@ -19,93 +19,110 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 // https://jira.sonarsource.com/browse/RSPEC-3776
-var nodes_1 = require("../utils/nodes");
-var locations_1 = require("../utils/locations");
-var DEFAULT_THRESHOLD = 15;
-var rule = {
+const nodes_1 = require("../utils/nodes");
+const locations_1 = require("../utils/locations");
+const DEFAULT_THRESHOLD = 15;
+const rule = {
     meta: {
+        type: "suggestion",
         schema: [
             { type: "integer", minimum: 0 },
             {
                 // internal parameter
-                enum: ["sonar-runtime"],
+                enum: ["sonar-runtime", "metric"],
             },
         ],
     },
-    create: function (context) {
-        var threshold = context.options[0] !== undefined ? context.options[0] : DEFAULT_THRESHOLD;
+    create(context) {
+        const threshold = getThreshold();
+        const isFileComplexity = context.options.includes("metric");
+        /** Complexity of the file */
+        let fileComplexity = 0;
         /** Complexity of the current function if it is *not* considered nested to the first level function */
-        var complexityIfNotNested = [];
+        let complexityIfNotNested = [];
         /** Complexity of the current function if it is considered nested to the first level function */
-        var complexityIfNested = [];
+        let complexityIfNested = [];
         /** Current nesting level (number of enclosing control flow statements and functions) */
-        var nesting = 0;
+        let nesting = 0;
         /** Indicator if the current top level function has a structural (generated by control flow statements) complexity */
-        var topLevelHasStructuralComplexity = false;
+        let topLevelHasStructuralComplexity = false;
         /** Own (not including nested functions) complexity of the current top function */
-        var topLevelOwnComplexity = [];
+        let topLevelOwnComplexity = [];
         /** Nodes that should increase nesting level  */
-        var nestingNodes = new Set();
+        const nestingNodes = new Set();
         /** Set of already considered (with already computed complexity) logical expressions */
-        var consideredLogicalExpressions = new Set();
+        const consideredLogicalExpressions = new Set();
         /** Stack of enclosing functions */
-        var enclosingFunctions = [];
-        var secondLevelFunctions = [];
+        const enclosingFunctions = [];
+        let secondLevelFunctions = [];
         return {
-            ":function": function (node) {
+            ":function": (node) => {
                 onEnterFunction(node);
             },
-            ":function:exit": function (node) {
+            ":function:exit"(node) {
                 onLeaveFunction(node);
             },
-            "*": function (node) {
+            "*"(node) {
                 if (nestingNodes.has(node)) {
                     nesting++;
                 }
             },
-            "*:exit": function (node) {
+            "*:exit"(node) {
                 if (nestingNodes.has(node)) {
                     nesting--;
                     nestingNodes.delete(node);
                 }
             },
-            IfStatement: function (node) {
+            Program() {
+                fileComplexity = 0;
+            },
+            "Program:exit"(node) {
+                if (isFileComplexity) {
+                    // as issues are the only communication channel of a rule
+                    // we pass data as serialized json as an issue message
+                    context.report({ node, message: fileComplexity.toString() });
+                }
+            },
+            IfStatement(node) {
                 visitIfStatement(node);
             },
-            ForStatement: function (node) {
+            ForStatement(node) {
                 visitLoop(node);
             },
-            ForInStatement: function (node) {
+            ForInStatement(node) {
                 visitLoop(node);
             },
-            ForOfStatement: function (node) {
+            ForOfStatement(node) {
                 visitLoop(node);
             },
-            DoWhileStatement: function (node) {
+            DoWhileStatement(node) {
                 visitLoop(node);
             },
-            WhileStatement: function (node) {
+            WhileStatement(node) {
                 visitLoop(node);
             },
-            SwitchStatement: function (node) {
+            SwitchStatement(node) {
                 visitSwitchStatement(node);
             },
-            ContinueStatement: function (node) {
+            ContinueStatement(node) {
                 visitContinueOrBreakStatement(node);
             },
-            BreakStatement: function (node) {
+            BreakStatement(node) {
                 visitContinueOrBreakStatement(node);
             },
-            CatchClause: function (node) {
+            CatchClause(node) {
                 visitCatchClause(node);
             },
-            LogicalExpression: function (node) {
+            LogicalExpression(node) {
                 visitLogicalExpression(node);
             },
-            ConditionalExpression: function (node) {
+            ConditionalExpression(node) {
                 visitConditionalExpression(node);
             },
         };
+        function getThreshold() {
+            return context.options[0] !== undefined ? context.options[0] : DEFAULT_THRESHOLD;
+        }
         function onEnterFunction(node) {
             if (enclosingFunctions.length === 0) {
                 // top level function
@@ -129,15 +146,15 @@ var rule = {
             if (enclosingFunctions.length === 0) {
                 // top level function
                 if (topLevelHasStructuralComplexity) {
-                    var totalComplexity_1 = topLevelOwnComplexity;
-                    secondLevelFunctions.forEach(function (secondLevelFunction) {
-                        totalComplexity_1 = totalComplexity_1.concat(secondLevelFunction.complexityIfNested);
+                    let totalComplexity = topLevelOwnComplexity;
+                    secondLevelFunctions.forEach(secondLevelFunction => {
+                        totalComplexity = totalComplexity.concat(secondLevelFunction.complexityIfNested);
                     });
-                    checkFunction(totalComplexity_1, locations_1.getMainFunctionTokenLocation(node, nodes_1.getParent(context), context));
+                    checkFunction(totalComplexity, locations_1.getMainFunctionTokenLocation(node, nodes_1.getParent(context), context));
                 }
                 else {
                     checkFunction(topLevelOwnComplexity, locations_1.getMainFunctionTokenLocation(node, nodes_1.getParent(context), context));
-                    secondLevelFunctions.forEach(function (secondLevelFunction) {
+                    secondLevelFunctions.forEach(secondLevelFunction => {
                         checkFunction(secondLevelFunction.complexityIfThisSecondaryIsTopLevel, locations_1.getMainFunctionTokenLocation(secondLevelFunction.node, secondLevelFunction.parent, context));
                     });
                 }
@@ -145,9 +162,9 @@ var rule = {
             else if (enclosingFunctions.length === 1) {
                 // second level function
                 secondLevelFunctions.push({
-                    node: node,
+                    node,
                     parent: nodes_1.getParent(context),
-                    complexityIfNested: complexityIfNested,
+                    complexityIfNested,
                     complexityIfThisSecondaryIsTopLevel: complexityIfNotNested,
                     loc: locations_1.getMainFunctionTokenLocation(node, nodes_1.getParent(context), context),
                 });
@@ -158,8 +175,8 @@ var rule = {
             }
         }
         function visitIfStatement(ifStatement) {
-            var parent = nodes_1.getParent(context);
-            var ifLoc = locations_1.getFirstToken(ifStatement, context).loc;
+            const parent = nodes_1.getParent(context);
+            const { loc: ifLoc } = locations_1.getFirstToken(ifStatement, context);
             // if the current `if` statement is `else if`, do not count it in structural complexity
             if (nodes_1.isIfStatement(parent) && parent.alternate === ifStatement) {
                 addComplexity(ifLoc);
@@ -174,7 +191,7 @@ var rule = {
             // - add +1 complexity
             if (ifStatement.alternate && !nodes_1.isIfStatement(ifStatement.alternate)) {
                 nestingNodes.add(ifStatement.alternate);
-                var elseTokenLoc = locations_1.getFirstTokenAfter(ifStatement.consequent, context).loc;
+                const elseTokenLoc = locations_1.getFirstTokenAfter(ifStatement.consequent, context).loc;
                 addComplexity(elseTokenLoc);
             }
         }
@@ -184,8 +201,7 @@ var rule = {
         }
         function visitSwitchStatement(switchStatement) {
             addStructuralComplexity(locations_1.getFirstToken(switchStatement, context).loc);
-            for (var _i = 0, _a = switchStatement.cases; _i < _a.length; _i++) {
-                var switchCase = _a[_i];
+            for (const switchCase of switchStatement.cases) {
                 nestingNodes.add(switchCase);
             }
         }
@@ -199,19 +215,18 @@ var rule = {
             nestingNodes.add(catchClause.body);
         }
         function visitConditionalExpression(conditionalExpression) {
-            var questionTokenLoc = locations_1.getFirstTokenAfter(conditionalExpression.test, context).loc;
+            const questionTokenLoc = locations_1.getFirstTokenAfter(conditionalExpression.test, context).loc;
             addStructuralComplexity(questionTokenLoc);
             nestingNodes.add(conditionalExpression.consequent);
             nestingNodes.add(conditionalExpression.alternate);
         }
         function visitLogicalExpression(logicalExpression) {
             if (!consideredLogicalExpressions.has(logicalExpression)) {
-                var flattenedLogicalExpressions = flattenLogicalExpression(logicalExpression);
-                var previous = void 0;
-                for (var _i = 0, flattenedLogicalExpressions_1 = flattenedLogicalExpressions; _i < flattenedLogicalExpressions_1.length; _i++) {
-                    var current = flattenedLogicalExpressions_1[_i];
+                const flattenedLogicalExpressions = flattenLogicalExpression(logicalExpression);
+                let previous;
+                for (const current of flattenedLogicalExpressions) {
                     if (!previous || previous.operator !== current.operator) {
-                        var operatorTokenLoc = locations_1.getFirstTokenAfter(logicalExpression.left, context).loc;
+                        const operatorTokenLoc = locations_1.getFirstTokenAfter(logicalExpression.left, context).loc;
                         addComplexity(operatorTokenLoc);
                     }
                     previous = current;
@@ -221,27 +236,35 @@ var rule = {
         function flattenLogicalExpression(node) {
             if (nodes_1.isLogicalExpression(node)) {
                 consideredLogicalExpressions.add(node);
-                return flattenLogicalExpression(node.left).concat([node], flattenLogicalExpression(node.right));
+                return [...flattenLogicalExpression(node.left), node, ...flattenLogicalExpression(node.right)];
             }
             return [];
         }
         function addStructuralComplexity(location) {
-            var added = nesting + 1;
-            var complexityPoint = { complexity: added, location: location };
-            if (enclosingFunctions.length === 1) {
+            const added = nesting + 1;
+            const complexityPoint = { complexity: added, location };
+            if (enclosingFunctions.length === 0) {
+                // top level scope
+                fileComplexity += added;
+            }
+            else if (enclosingFunctions.length === 1) {
                 // top level function
                 topLevelHasStructuralComplexity = true;
                 topLevelOwnComplexity.push(complexityPoint);
             }
             else {
                 // second+ level function
-                complexityIfNested.push({ complexity: added + 1, location: location });
+                complexityIfNested.push({ complexity: added + 1, location });
                 complexityIfNotNested.push(complexityPoint);
             }
         }
         function addComplexity(location) {
-            var complexityPoint = { complexity: 1, location: location };
-            if (enclosingFunctions.length === 1) {
+            const complexityPoint = { complexity: 1, location };
+            if (enclosingFunctions.length === 0) {
+                // top level scope
+                fileComplexity += 1;
+            }
+            else if (enclosingFunctions.length === 1) {
                 // top level function
                 topLevelOwnComplexity.push(complexityPoint);
             }
@@ -251,18 +274,21 @@ var rule = {
                 complexityIfNotNested.push(complexityPoint);
             }
         }
-        function checkFunction(complexity, loc) {
-            if (complexity === void 0) { complexity = []; }
-            var complexityAmount = complexity.reduce(function (acc, cur) { return acc + cur.complexity; }, 0);
+        function checkFunction(complexity = [], loc) {
+            const complexityAmount = complexity.reduce((acc, cur) => acc + cur.complexity, 0);
+            fileComplexity += complexityAmount;
+            if (isFileComplexity) {
+                return;
+            }
             if (complexityAmount > threshold) {
-                var secondaryLocations = complexity.map(function (complexityPoint) {
-                    var complexity = complexityPoint.complexity, location = complexityPoint.location;
-                    var message = complexity === 1 ? "+1" : "+" + complexity + " (incl. " + (complexity - 1) + " for nesting)";
+                const secondaryLocations = complexity.map(complexityPoint => {
+                    const { complexity, location } = complexityPoint;
+                    const message = complexity === 1 ? "+1" : `+${complexity} (incl. ${complexity - 1} for nesting)`;
                     return locations_1.issueLocation(location, undefined, message);
                 });
                 locations_1.report(context, {
-                    message: "Refactor this function to reduce its Cognitive Complexity from " + complexityAmount + " to the " + threshold + " allowed.",
-                    loc: loc,
+                    message: `Refactor this function to reduce its Cognitive Complexity from ${complexityAmount} to the ${threshold} allowed.`,
+                    loc,
                 }, secondaryLocations, complexityAmount - threshold);
             }
         }