acharkizakaria/haraka-plugin-accounting-files

View on GitHub

Showing 30 of 30 total issues

File index.js has 372 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// accounting_files
//------------
// documentation via: `haraka -h accounting_files`

//var outbound     = require("./outbound");
Severity: Minor
Found in index.js - About 4 hrs to fix

    Similar blocks of code found in 3 locations. Consider refactoring.
    Open

        if ( type == 'delivered' ){
            //Set new paths to the notes
            server.notes.delivered_file_path = path.join( server.notes.delivered_dir_path, "d." + dateFormat(new Date(), "yyyy-mm-dd-HHMMss") + "." + server.notes.files_extension);
            createFileIfNotExist(server.notes.delivered_file_path, server.notes.delivered_fields);     //Create delivered file
    
    
    Severity: Major
    Found in index.js and 2 other locations - About 4 hrs to fix
    index.js on lines 365..380
    index.js on lines 373..380

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 115.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 3 locations. Consider refactoring.
    Open

        else if ( type == 'bounce' ){
            //Set new paths to the notes
            server.notes.bounce_file_path = path.join( server.notes.bounce_dir_path, "b." + dateFormat(new Date(), "yyyy-mm-dd-HHMMss") + "." + server.notes.files_extension);
            createFileIfNotExist(server.notes.bounce_file_path, server.notes.bounce_fields);    //Create bounce file
    
    
    Severity: Major
    Found in index.js and 2 other locations - About 4 hrs to fix
    index.js on lines 357..380
    index.js on lines 365..380

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 115.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 3 locations. Consider refactoring.
    Open

        else if ( type == 'deferred' ){
            //Set new paths to the notes
            server.notes.deferred_file_path = path.join( server.notes.deferred_dir_path, "t." + dateFormat(new Date(), "yyyy-mm-dd-HHMMss") + "." + server.notes.files_extension);
            createFileIfNotExist(server.notes.deferred_file_path, server.notes.deferred_fields);    //Create deferred file
    
    
    Severity: Major
    Found in index.js and 2 other locations - About 4 hrs to fix
    index.js on lines 357..380
    index.js on lines 373..380

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 115.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Function bounce has 63 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    exports.bounce  = function (next, hmail, error) {
        var plugin  = this;
        var todo    = hmail.todo;
        var header  = hmail.notes.header;
        var rcpt_to = todo.rcpt_to[0];
    Severity: Major
    Found in index.js - About 2 hrs to fix

      Function init_plugin has 63 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      exports.init_plugin = function (next)  {
          var context                 = this;
          var acct_path               = cfg.main.path || path.join(process.env.HARAKA, "accounting_files");
          var separator               = cfg.main.separator || "    ";
          var files_extension         = cfg.main.extension || "tsv";
      Severity: Major
      Found in index.js - About 2 hrs to fix

        Function deferred has 58 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        exports.deferred = function (next, hmail, params) {
            var plugin   = this;
            var todo     = hmail.todo;
            var header   = hmail.notes.header;
            var rcpt_to  = todo.rcpt_to[0];
        Severity: Major
        Found in index.js - About 2 hrs to fix

          Function delivered has 55 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          exports.delivered = function (next, hmail, params) {
              var plugin    = this;
              var todo      = hmail.todo;
              var header    = hmail.notes.header;
              var rcpt_to   = todo.rcpt_to[0];
          Severity: Major
          Found in index.js - About 2 hrs to fix

            Function init_plugin has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
            Open

            exports.init_plugin = function (next)  {
                var context                 = this;
                var acct_path               = cfg.main.path || path.join(process.env.HARAKA, "accounting_files");
                var separator               = cfg.main.separator || "    ";
                var files_extension         = cfg.main.extension || "tsv";
            Severity: Minor
            Found in index.js - About 1 hr to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                            fs.rename(from_dir + "/" + filename, to_dir + "/" + filename, function (_err) {
                                if (_err) {
                                    context.loginfo("Can't archive file '" + filename + "' " + _err);
                                    throw _err;
                                } else {
            Severity: Major
            Found in index.js and 1 other location - About 1 hr to fix
            index.js on lines 480..487

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 63.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                    fs.rename(filename, archive_to_path + "/" + file_base_name, function (err) {
                        if (err) {
                            context.loginfo("Can't move file '" + file_base_name + "' " + err);
                            throw err;
                        } else {
            Severity: Major
            Found in index.js and 1 other location - About 1 hr to fix
            index.js on lines 441..448

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 63.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Function addRecord has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            var addRecord = function (filename, fields, fields_values, type, context) {
            Severity: Minor
            Found in index.js - About 35 mins to fix

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                          case (field.match(/^custom_/) || {}).input :
                              fields_values[field] = header.get(field) || " - ";
                              break;
              Severity: Minor
              Found in index.js and 2 other locations - About 30 mins to fix
              index.js on lines 168..170
              index.js on lines 299..301

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 45.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                          case (field.match(/^custom_/) || {}).input :
                              fields_values[field] = header.get(field) || " - ";
                              break;
              Severity: Minor
              Found in index.js and 2 other locations - About 30 mins to fix
              index.js on lines 232..234
              index.js on lines 299..301

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 45.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                          case (field.match(/^custom_/) || {}).input :
                              fields_values[field] = header.get(field) || " - ";
                              break;
              Severity: Minor
              Found in index.js and 2 other locations - About 30 mins to fix
              index.js on lines 168..170
              index.js on lines 232..234

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 45.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              'exports' is not defined.
              Open

              exports.set_header_to_note = function (next, connection) {
              Severity: Minor
              Found in index.js by eslint

              Disallow Undeclared Variables (no-undef)

              This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

              Rule Details

              Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

              Examples of incorrect code for this rule:

              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              Examples of correct code for this rule with global declaration:

              /*global someFunction b:true*/
              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              The b:true syntax in /*global */ indicates that assignment to b is correct.

              Examples of incorrect code for this rule with global declaration:

              /*global b*/
              /*eslint no-undef: "error"*/
              
              b = 10;

              By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

              Options

              • typeof set to true will warn for variables used inside typeof check (Default false).

              typeof

              Examples of correct code for the default { "typeof": false } option:

              /*eslint no-undef: "error"*/
              
              if (typeof UndefinedIdentifier === "undefined") {
                  // do something ...
              }

              You can use this option if you want to prevent typeof check on a variable which has not been declared.

              Examples of incorrect code for the { "typeof": true } option:

              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Examples of correct code for the { "typeof": true } option with global declaration:

              /*global a*/
              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Environments

              For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

              browser

              Examples of correct code for this rule with browser environment:

              /*eslint no-undef: "error"*/
              /*eslint-env browser*/
              
              setTimeout(function() {
                  alert("Hello");
              });

              node

              Examples of correct code for this rule with node environment:

              /*eslint no-undef: "error"*/
              /*eslint-env node*/
              
              var fs = require("fs");
              module.exports = function() {
                  console.log(fs);
              };

              When Not To Use It

              If explicit declaration of global variables is not to your taste.

              Compatibility

              This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

              'exports' is not defined.
              Open

              exports.bounce  = function (next, hmail, error) {
              Severity: Minor
              Found in index.js by eslint

              Disallow Undeclared Variables (no-undef)

              This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

              Rule Details

              Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

              Examples of incorrect code for this rule:

              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              Examples of correct code for this rule with global declaration:

              /*global someFunction b:true*/
              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              The b:true syntax in /*global */ indicates that assignment to b is correct.

              Examples of incorrect code for this rule with global declaration:

              /*global b*/
              /*eslint no-undef: "error"*/
              
              b = 10;

              By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

              Options

              • typeof set to true will warn for variables used inside typeof check (Default false).

              typeof

              Examples of correct code for the default { "typeof": false } option:

              /*eslint no-undef: "error"*/
              
              if (typeof UndefinedIdentifier === "undefined") {
                  // do something ...
              }

              You can use this option if you want to prevent typeof check on a variable which has not been declared.

              Examples of incorrect code for the { "typeof": true } option:

              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Examples of correct code for the { "typeof": true } option with global declaration:

              /*global a*/
              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Environments

              For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

              browser

              Examples of correct code for this rule with browser environment:

              /*eslint no-undef: "error"*/
              /*eslint-env browser*/
              
              setTimeout(function() {
                  alert("Hello");
              });

              node

              Examples of correct code for this rule with node environment:

              /*eslint no-undef: "error"*/
              /*eslint-env node*/
              
              var fs = require("fs");
              module.exports = function() {
                  console.log(fs);
              };

              When Not To Use It

              If explicit declaration of global variables is not to your taste.

              Compatibility

              This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

              'exports' is not defined.
              Open

              exports.register = function () {
              Severity: Minor
              Found in index.js by eslint

              Disallow Undeclared Variables (no-undef)

              This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

              Rule Details

              Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

              Examples of incorrect code for this rule:

              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              Examples of correct code for this rule with global declaration:

              /*global someFunction b:true*/
              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              The b:true syntax in /*global */ indicates that assignment to b is correct.

              Examples of incorrect code for this rule with global declaration:

              /*global b*/
              /*eslint no-undef: "error"*/
              
              b = 10;

              By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

              Options

              • typeof set to true will warn for variables used inside typeof check (Default false).

              typeof

              Examples of correct code for the default { "typeof": false } option:

              /*eslint no-undef: "error"*/
              
              if (typeof UndefinedIdentifier === "undefined") {
                  // do something ...
              }

              You can use this option if you want to prevent typeof check on a variable which has not been declared.

              Examples of incorrect code for the { "typeof": true } option:

              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Examples of correct code for the { "typeof": true } option with global declaration:

              /*global a*/
              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Environments

              For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

              browser

              Examples of correct code for this rule with browser environment:

              /*eslint no-undef: "error"*/
              /*eslint-env browser*/
              
              setTimeout(function() {
                  alert("Hello");
              });

              node

              Examples of correct code for this rule with node environment:

              /*eslint no-undef: "error"*/
              /*eslint-env node*/
              
              var fs = require("fs");
              module.exports = function() {
                  console.log(fs);
              };

              When Not To Use It

              If explicit declaration of global variables is not to your taste.

              Compatibility

              This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

              'exports' is not defined.
              Open

              exports.deferred = function (next, hmail, params) {
              Severity: Minor
              Found in index.js by eslint

              Disallow Undeclared Variables (no-undef)

              This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

              Rule Details

              Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

              Examples of incorrect code for this rule:

              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              Examples of correct code for this rule with global declaration:

              /*global someFunction b:true*/
              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              The b:true syntax in /*global */ indicates that assignment to b is correct.

              Examples of incorrect code for this rule with global declaration:

              /*global b*/
              /*eslint no-undef: "error"*/
              
              b = 10;

              By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

              Options

              • typeof set to true will warn for variables used inside typeof check (Default false).

              typeof

              Examples of correct code for the default { "typeof": false } option:

              /*eslint no-undef: "error"*/
              
              if (typeof UndefinedIdentifier === "undefined") {
                  // do something ...
              }

              You can use this option if you want to prevent typeof check on a variable which has not been declared.

              Examples of incorrect code for the { "typeof": true } option:

              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Examples of correct code for the { "typeof": true } option with global declaration:

              /*global a*/
              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Environments

              For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

              browser

              Examples of correct code for this rule with browser environment:

              /*eslint no-undef: "error"*/
              /*eslint-env browser*/
              
              setTimeout(function() {
                  alert("Hello");
              });

              node

              Examples of correct code for this rule with node environment:

              /*eslint no-undef: "error"*/
              /*eslint-env node*/
              
              var fs = require("fs");
              module.exports = function() {
                  console.log(fs);
              };

              When Not To Use It

              If explicit declaration of global variables is not to your taste.

              Compatibility

              This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

              'clearInterval' is not defined.
              Open

                          clearInterval(server.notes.archive_interval);
              Severity: Minor
              Found in index.js by eslint

              Disallow Undeclared Variables (no-undef)

              This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

              Rule Details

              Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

              Examples of incorrect code for this rule:

              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              Examples of correct code for this rule with global declaration:

              /*global someFunction b:true*/
              /*eslint no-undef: "error"*/
              
              var a = someFunction();
              b = 10;

              The b:true syntax in /*global */ indicates that assignment to b is correct.

              Examples of incorrect code for this rule with global declaration:

              /*global b*/
              /*eslint no-undef: "error"*/
              
              b = 10;

              By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

              Options

              • typeof set to true will warn for variables used inside typeof check (Default false).

              typeof

              Examples of correct code for the default { "typeof": false } option:

              /*eslint no-undef: "error"*/
              
              if (typeof UndefinedIdentifier === "undefined") {
                  // do something ...
              }

              You can use this option if you want to prevent typeof check on a variable which has not been declared.

              Examples of incorrect code for the { "typeof": true } option:

              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Examples of correct code for the { "typeof": true } option with global declaration:

              /*global a*/
              /*eslint no-undef: ["error", { "typeof": true }] */
              
              if(typeof a === "string"){}

              Environments

              For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

              browser

              Examples of correct code for this rule with browser environment:

              /*eslint no-undef: "error"*/
              /*eslint-env browser*/
              
              setTimeout(function() {
                  alert("Hello");
              });

              node

              Examples of correct code for this rule with node environment:

              /*eslint no-undef: "error"*/
              /*eslint-env node*/
              
              var fs = require("fs");
              module.exports = function() {
                  console.log(fs);
              };

              When Not To Use It

              If explicit declaration of global variables is not to your taste.

              Compatibility

              This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

              Severity
              Category
              Status
              Source
              Language