ForestAdmin/toolbelt

View on GitHub
src/services/dumpers/forest-express.js

Summary

Maintainability
D
2 days
Test Coverage
A
100%

File forest-express.js has 327 lines of code (exceeds 250 allowed). Consider refactoring.
Open

const { URL } = require('url');
const { plural, singular } = require('pluralize');
const IncompatibleLianaForUpdateError = require('../../errors/dumper/incompatible-liana-for-update-error');
const InvalidForestCLIProjectStructureError = require('../../errors/dumper/invalid-forest-cli-project-structure-error');
const AbstractDumper = require('./abstract-dumper').default;
Severity: Minor
Found in src/services/dumpers/forest-express.js - About 3 hrs to fix

    ForestExpress has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class ForestExpress extends AbstractDumper {
      templateFolder = 'forest-express';
    
      constructor(context) {
        super(context);
    Severity: Minor
    Found in src/services/dumpers/forest-express.js - About 2 hrs to fix

      Function writeModel has 47 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        writeModel(config, table, fields, references, options = {}) {
          const { underscored } = options;
          let modelPath = `models/${this.tableToFilename(table)}.js`;
          if (config.appConfig.useMultiDatabase) {
            modelPath = `models/${config.appConfig.modelsExportPath}/${this.tableToFilename(table)}.js`;
      Severity: Minor
      Found in src/services/dumpers/forest-express.js - About 1 hr to fix

        Function createFiles has 45 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          async createFiles(config, schema) {
            const { isUpdate, useMultiDatabase, modelsExportPath } = config.appConfig;
        
            await this.mkdirp(`${this.projectPath}/routes`);
            await this.mkdirp(`${this.projectPath}/forest`);
        Severity: Minor
        Found in src/services/dumpers/forest-express.js - About 1 hr to fix

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

            constructor(context) {
              super(context);
          
              const {
                assertPresent,
          Severity: Minor
          Found in src/services/dumpers/forest-express.js - About 1 hr to fix

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

              writePackageJson(dbDialect, appName) {
                const orm = dbDialect === 'mongodb' ? 'mongoose' : 'sequelize';
                const dependencies = {
                  'body-parser': '1.19.0',
                  chalk: '~1.1.3',
            Severity: Minor
            Found in src/services/dumpers/forest-express.js - About 1 hr to fix

              Function writeModel has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
              Open

                writeModel(config, table, fields, references, options = {}) {
                  const { underscored } = options;
                  let modelPath = `models/${this.tableToFilename(table)}.js`;
                  if (config.appConfig.useMultiDatabase) {
                    modelPath = `models/${config.appConfig.modelsExportPath}/${this.tableToFilename(table)}.js`;
              Severity: Minor
              Found in src/services/dumpers/forest-express.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

              Function writePackageJson has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                writePackageJson(dbDialect, appName) {
                  const orm = dbDialect === 'mongodb' ? 'mongoose' : 'sequelize';
                  const dependencies = {
                    'body-parser': '1.19.0',
                    chalk: '~1.1.3',
              Severity: Minor
              Found in src/services/dumpers/forest-express.js - About 35 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

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

                writeDockerCompose(config) {
                  const databaseUrl = `\${${this.isLinuxOs ? 'DATABASE_URL' : 'DOCKER_DATABASE_URL'}}`;
                  const forestUrl = this.env.FOREST_URL_IS_DEFAULT
                    ? false
                    : `\${FOREST_URL-${this.env.FOREST_SERVER_URL}}`;
              Severity: Minor
              Found in src/services/dumpers/forest-express.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

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

                async createFiles(config, schema) {
                  const { isUpdate, useMultiDatabase, modelsExportPath } = config.appConfig;
              
                  await this.mkdirp(`${this.projectPath}/routes`);
                  await this.mkdirp(`${this.projectPath}/forest`);
              Severity: Minor
              Found in src/services/dumpers/forest-express.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

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

                  assertPresent({
                    env,
                    Sequelize,
                    Handlebars,
                    mkdirp,
              Severity: Major
              Found in src/services/dumpers/forest-express.js and 1 other location - About 1 hr to fix
              src/services/schema/schema-service.js on lines 17..28

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

              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