nukeop/nuclear

View on GitHub
packages/main/src/services/http/server/swagger.ts

Summary

Maintainability
B
5 hrs
Test Coverage

Function initSwagger has 79 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function initSwagger(app: Express): void {
  swagger.reset();
  swagger.initialise(app, {
    title: 'Nuclear REST API',
    description: 'This Api allow you to remotly control nuclear desktop app',
Severity: Major
Found in packages/main/src/services/http/server/swagger.ts - About 3 hrs to fix

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

      swagger.common.parameters.addPath({
        name: 'name',
        description: 'The name of the playlist to remove',
        required: true,
        ...deletePlaylistSchema.params.properties.name
    Severity: Major
    Found in packages/main/src/services/http/server/swagger.ts and 2 other locations - About 45 mins to fix
    packages/main/src/services/http/server/swagger.ts on lines 96..101
    packages/main/src/services/http/server/swagger.ts on lines 117..122

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

    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 3 locations. Consider refactoring.
    Open

      swagger.common.parameters.addPath({
        name: 'eqName',
        description: 'The name of the equalizer presets to set',
        required: true,
        ...setEqualizerSchema.params.properties.name
    Severity: Major
    Found in packages/main/src/services/http/server/swagger.ts and 2 other locations - About 45 mins to fix
    packages/main/src/services/http/server/swagger.ts on lines 96..101
    packages/main/src/services/http/server/swagger.ts on lines 110..115

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

    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 3 locations. Consider refactoring.
    Open

      swagger.common.parameters.addPath({
        name: 'option',
        description: 'The name of the settings you want to get / update',
        required: true,
        ...getSettingsSchema.params.properties.option
    Severity: Major
    Found in packages/main/src/services/http/server/swagger.ts and 2 other locations - About 45 mins to fix
    packages/main/src/services/http/server/swagger.ts on lines 110..115
    packages/main/src/services/http/server/swagger.ts on lines 117..122

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

    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