Sign upLogin

contentascode/docsmith

View on GitHub
Star
src/docsmith-install.js

Summary

Maintainability
D
1 day
Test Coverage

Function create_travis_yml has 60 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function create_travis_yml(gh_token) {
  return new Promise(function(resolve, reject) {
    // This builds the yaml in memory including the secure token and writes the file
    // It could also use a moustache style template in integration/travis/.travis.yml
Severity: Major
Found in src/docsmith-install.js - About 2 hrs to fix

    File docsmith-install.js has 256 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    #!/usr/bin/env node

/**
 * Module dependencies.
 */
    Severity: Minor
    Found in src/docsmith-install.js - About 2 hrs to fix

      Function npm_build has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function npm_build(src, dest) {
  const load_npm_build_yaml = new Promise(function(resolve) {
    resolve(yaml.safeLoad(fs.readFileSync(path.join(templates.path, src), 'utf8')));
  });
      Severity: Minor
      Found in src/docsmith-install.js - About 2 hrs to fix

        Function read_package_json has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          const read_package_json = function(yaml) {
    const check_package_json = new Promise(function(resolve, reject) {
      fs.stat(dest, function(err, stats) {
        if (err) {
          resolve(false);
        Severity: Minor
        Found in src/docsmith-install.js - About 1 hr to fix

          Function npm_build has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

          function npm_build(src, dest) {
  const load_npm_build_yaml = new Promise(function(resolve) {
    resolve(yaml.safeLoad(fs.readFileSync(path.join(templates.path, src), 'utf8')));
  });
          Severity: Minor
          Found in src/docsmith-install.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

              const promise_email = git.Config
      .openDefault()
      .then(function(config) {
        return config.getString('user.email');
      })
          Severity: Major
          Found in src/docsmith-install.js and 1 other location - About 2 hrs to fix
          src/docsmith-install.js on lines 176..185

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

          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

              const promise_name = git.Config
      .openDefault()
      .then(function(config) {
        return config.getString('user.name');
      })
          Severity: Major
          Found in src/docsmith-install.js and 1 other location - About 2 hrs to fix
          src/docsmith-install.js on lines 187..196

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

          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

          program
  .description('install one or more components with their default settings or a specific plugin')
  .option('-f, --force', 'Initialise whether the current directory is empty or not.', id, false)
  .option('--git-name <git_name>', 'Overrides the current git user name or GIT_NAME env variable for the travis plugin')
  .option('--git-email <git_email>', 'Overrides the current git email or GIT_EMAIL env variablefor the travis plugin')
          Severity: Major
          Found in src/docsmith-install.js and 1 other location - About 1 hr to fix
          src/docsmith-build.js on lines 17..24

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

          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