polkadot-js/api

View on GitHub
packages/typegen/src/generate/consts.ts

Summary

Maintainability
C
1 day
Test Coverage

Function generateForMeta has 57 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function generateForMeta (meta: Metadata, dest: string, extraTypes: ExtraTypes, isStrict: boolean, customLookupDefinitions?: Definitions): void {
  writeFile(dest, (): string => {
    const allTypes = {
      '@polkadot/types-augment': {
        lookup: {
Severity: Major
Found in packages/typegen/src/generate/consts.ts - About 2 hrs to fix

    Function generateDefaultConsts has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    export function generateDefaultConsts (dest: string, data: HexString, extraTypes: ExtraTypes = {}, isStrict = false, customLookupDefinitions?: Definitions): void {
    Severity: Minor
    Found in packages/typegen/src/generate/consts.ts - About 35 mins to fix

      Function generateForMeta has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      function generateForMeta (meta: Metadata, dest: string, extraTypes: ExtraTypes, isStrict: boolean, customLookupDefinitions?: Definitions): void {
      Severity: Minor
      Found in packages/typegen/src/generate/consts.ts - About 35 mins to fix

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

            const allDefs = Object.entries(allTypes).reduce((defs, [path, obj]) => {
              return Object.entries(obj).reduce((defs, [key, value]) => ({ ...defs, [`${path}/${key}`]: value }), defs);
            }, {});
        Severity: Major
        Found in packages/typegen/src/generate/consts.ts and 5 other locations - About 2 hrs to fix
        packages/typegen/src/generate/events.ts on lines 77..79
        packages/typegen/src/generate/query.ts on lines 85..87
        packages/typegen/src/generate/rpc.ts on lines 38..40
        packages/typegen/src/generate/runtime.ts on lines 101..103
        packages/typegen/src/generate/tx.ts on lines 45..47

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

        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

        export function generateDefaultConsts (dest: string, data: HexString, extraTypes: ExtraTypes = {}, isStrict = false, customLookupDefinitions?: Definitions): void {
          const { metadata } = initMeta(data, extraTypes);
        
          return generateForMeta(metadata, dest, extraTypes, isStrict, customLookupDefinitions);
        }
        Severity: Major
        Found in packages/typegen/src/generate/consts.ts and 1 other location - About 2 hrs to fix
        packages/typegen/src/generate/events.ts on lines 129..133

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

        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