Sign upLogin

guidesmiths/generator-systemic

View on GitHub
Star

Showing 13 of 13 total issues

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

module.exports = () => {
  const start = async ({ app, logger, controller }) => {
    /**
     * GET /v2/message/{id}
     * @summary Endpoint to retrieve a message
Severity: Major
Found in generators/app/templates/lib/components/routes/v2/api-routes.js and 1 other location - About 1 day to fix
generators/app/templates/lib/components/routes/v1/api-routes.js on lines 5..37

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

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

module.exports = () => {
  const start = async ({ app, logger, controller }) => {
    /**
     * GET /v1/message/{id}
     * @summary Endpoint to retrieve a message
Severity: Major
Found in generators/app/templates/lib/components/routes/v1/api-routes.js and 1 other location - About 1 day to fix
generators/app/templates/lib/components/routes/v2/api-routes.js on lines 5..37

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

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

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

    const getMessage = async id => {
      try {
        const message = await store.getMessage(id);
        return message ? format(message) : null;
      } catch (error) {
Severity: Major
Found in generators/app/templates/lib/components/controller/api/v1/initController.js and 1 other location - About 2 hrs to fix
generators/app/templates/lib/components/controller/api/v2/initController.js on lines 9..17

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

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

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

    const getMessage = async id => {
      try {
        const message = await store.getMessage(id);
        return message ? format(message) : null;
      } catch (error) {
Severity: Major
Found in generators/app/templates/lib/components/controller/api/v2/initController.js and 1 other location - About 2 hrs to fix
generators/app/templates/lib/components/controller/api/v1/initController.js on lines 8..16

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

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 prompting has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  prompting() {
    this.log(
      yosay(`Welcome to the unreal ${chalk.red('systemic')} generator!`),
    );
Severity: Major
Found in generators/app/index.js - About 2 hrs to fix

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

    module.exports = () => {
  const onMessage = event => {
    const details = R.pluck(event, []);
    const data = R.merge(event, {
      displayTracer: R.has('tracer', event) ? event.tracer.substr(0, 6) : '|',
    Severity: Minor
    Found in generators/app/templates/lib/components/logging/console.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 exports has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    module.exports = () => {
  const start = async ({ rabbitmq }) => {
    const publish = (...args) => new Promise((resolve, reject) => {
      rabbitmq.broker.publish(...args, (err, publication) => {
        if (err) return reject(err);
    Severity: Minor
    Found in generators/app/templates/lib/components/bus/initBus.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 exports has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    module.exports = () => {
  const start = async ({ mongodb, config, logger }) => {
    const db = await mongodb.db(config.databaseName);
    const collection = await db.collection(config.collectionName);
    Severity: Minor
    Found in generators/app/templates/lib/components/store/initStore.js - About 1 hr to fix

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

      module.exports = () => {
  const start = async ({ rabbitmq }) => {
    const publish = (...args) => new Promise((resolve, reject) => {
      rabbitmq.broker.publish(...args, (err, publication) => {
        if (err) return reject(err);
      Severity: Minor
      Found in generators/app/templates/lib/components/bus/initBus.js - About 1 hr to fix

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

        module.exports = new System({ name: 'express' })
  .add('app', app()).dependsOn('config', 'logger')
  .add('middleware.default', defaultMiddleware())
  .dependsOn('logger', 'app', 'routes')
        Severity: Minor
        Found in generators/app/templates/lib/components/express/index.js and 1 other location - About 55 mins to fix
        generators/app/templates/lib/components/store/index.js on lines 5..9

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

        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

        module.exports = new System({ name: 'store' })
  .add('mongodb', mongodb())
  .dependsOn('config', 'logger')
  .add('store', initStore())
  .dependsOn('mongodb', 'config', 'logger');
        Severity: Minor
        Found in generators/app/templates/lib/components/store/index.js and 1 other location - About 55 mins to fix
        generators/app/templates/lib/components/express/index.js on lines 4..7

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

        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 exports has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        module.exports = () => {
  const start = async ({ logger, store }) => {
    const format = message => ({
      id: message.id,
      text: message.text.toLowerCase(),
        Severity: Minor
        Found in generators/app/templates/lib/components/controller/api/v1/initController.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 exports has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        module.exports = () => {
  const start = async ({ logger, store }) => {
    const format = message => ({
      id: message.id,
      text: message.text.toUpperCase(),
        Severity: Minor
        Found in generators/app/templates/lib/components/controller/api/v2/initController.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