Sign upLogin

trufflesuite/truffle

View on GitHub
Star
packages/core/lib/console.js

Summary

Maintainability
D
3 days
Test Coverage

File console.js has 388 lines of code (exceeds 250 allowed). Consider refactoring.
Open

const repl = require("repl");
const provision = require("@truffle/provisioner");
const {
  Web3Shim,
  createInterfaceAdapter
Severity: Minor
Found in packages/core/lib/console.js - About 5 hrs to fix

    Function interpret has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

      async interpret(input, context, filename, callback) {
    const processedInput = processInput(input);
    if (validTruffleConsoleCommands.includes(processedInput.split(/\s+/)[0])) {
      try {
        parseQuotesAndEscapes(processedInput); //we're just doing this to see
    Severity: Minor
    Found in packages/core/lib/console.js - About 3 hrs 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

    Function interpret has 75 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async interpret(input, context, filename, callback) {
    const processedInput = processInput(input);
    if (validTruffleConsoleCommands.includes(processedInput.split(/\s+/)[0])) {
      try {
        parseQuotesAndEscapes(processedInput); //we're just doing this to see
    Severity: Major
    Found in packages/core/lib/console.js - About 3 hrs to fix

      Function getUserDefinedGlobals has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

        getUserDefinedGlobals({ accounts, interfaceAdapter, web3 }) {
    // exit if feature should be disabled
    if (this.options["require-none"]) return;

    // exit if no hydrate options are set
      Severity: Minor
      Found in packages/core/lib/console.js - About 2 hrs 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

      Function getUserDefinedGlobals has 52 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        getUserDefinedGlobals({ accounts, interfaceAdapter, web3 }) {
    // exit if feature should be disabled
    if (this.options["require-none"]) return;

    // exit if no hydrate options are set
      Severity: Major
      Found in packages/core/lib/console.js - About 2 hrs to fix

        Function provision has 44 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          provision() {
    let files = [];
    let jsonBlobs = [];
    try {
      files = fse.readdirSync(this.options.contracts_build_directory);
        Severity: Minor
        Found in packages/core/lib/console.js - About 1 hr to fix

          Function runSpawn has 37 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            async runSpawn(inputStrings, options) {
    let childPath;
    /* eslint-disable no-undef */
    if (typeof BUNDLE_CONSOLE_CHILD_FILENAME !== "undefined") {
      childPath = path.join(__dirname, BUNDLE_CONSOLE_CHILD_FILENAME);
          Severity: Minor
          Found in packages/core/lib/console.js - About 1 hr to fix

            Function constructor has 27 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              constructor(options) {
    super();
    EventEmitter.call(this);

    expect.options(options, [
            Severity: Minor
            Found in packages/core/lib/console.js - About 1 hr to fix

              Function start has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                async start() {
    try {
      // start the repl with an empty prompt and show a proper one when
      // the repl has set up its context and is ready to accept input
      this.repl = repl.start({
              Severity: Minor
              Found in packages/core/lib/console.js - About 1 hr to fix

                Function processInput has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                const processInput = input => {
  const words = input.trim().split(/\s+/);

  // empty input
  if (words.length === 0) return input;
                Severity: Minor
                Found in packages/core/lib/console.js - About 45 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

                Avoid too many return statements within this function.
                Open

                    return words.slice(1).join(" ");
                Severity: Major
                Found in packages/core/lib/console.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                    return input.trim();
                  Severity: Major
                  Found in packages/core/lib/console.js - About 30 mins to fix

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

                            if (error instanceof TruffleError) {
          console.log(error.message);
        } else {
          // Bubble up all other unexpected errors.
          console.log(error.stack || error.toString());
                    Severity: Major
                    Found in packages/core/lib/console.js and 1 other location - About 1 hr to fix
                    packages/core/lib/console-child.js on lines 58..63

                    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 60.

                    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

                    There are no issues that match your filters.

                    Category
                    Status