msimerson/safe-log-reader

View on GitHub

Showing 4 of 4 total issues

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

'use strict';

if (process.env.COVERAGE) require('blanket');

const events    = require('events');
Severity: Minor
Found in index.js - About 3 hrs to fix

    Reader has 22 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Reader extends events.EventEmitter {
    
      constructor (fileOrPath, options) {
        super()
    
    
    Severity: Minor
    Found in index.js - About 2 hrs to fix

      Function createStream has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        createStream () {
          // entered when:
          //     new startup
          //     after EOF, when fs.watch saw a change
          //
      Severity: Minor
      Found in index.js - About 1 hr to fix

        Function applyOptions has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

          applyOptions (options) {
            if (!options) options = { bookmark: { } };
        
            this.watchOpts  = { persistent: true, recursive: false };
            this.encoding   = options.encoding   || 'utf8';
        Severity: Minor
        Found in index.js - About 25 mins 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

        Severity
        Category
        Status
        Source
        Language