Sign upLogin

polkadot-js/api

View on GitHub
Star
packages/typegen/src/generate/runtime.ts

Summary

Maintainability
D
2 days
Test Coverage

Function getDefs has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
Open

function getDefs (apis: Apis | null, defs: Record<string, Definitions>): Record<string, Record<string, DefinitionCallNamed>> {
  const named: Record<string, Record<string, DefinitionCallNamed>> = {};
  const all = Object.values(defs);

  for (let j = 0, jcount = all.length; j < jcount; j++) {
Severity: Minor
Found in packages/typegen/src/generate/runtime.ts - About 5 hrs 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 generateCallTypes has 77 lines of code (exceeds 25 allowed). Consider refactoring.
Open

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

    Function getDefs has 34 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function getDefs (apis: Apis | null, defs: Record<string, Definitions>): Record<string, Record<string, DefinitionCallNamed>> {
  const named: Record<string, Record<string, DefinitionCallNamed>> = {};
  const all = Object.values(defs);

  for (let j = 0, jcount = all.length; j < jcount; j++) {
    Severity: Minor
    Found in packages/typegen/src/generate/runtime.ts - About 1 hr to fix

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

          const modules = callKeys.map((section) => {
      const calls = definitions[section];

      const allMethods = Object.keys(calls).sort().map((methodName) => {
        const def = calls[methodName];
      Severity: Minor
      Found in packages/typegen/src/generate/runtime.ts - About 1 hr to fix

        Avoid deeply nested control flow statements.
        Open

                  if (ver) {
            const methods = Object.entries(ver.methods);
            const mcount = methods.length;

            if (mcount) {
        Severity: Major
        Found in packages/typegen/src/generate/runtime.ts - About 45 mins to fix

          Function generateCallTypes has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          export function generateCallTypes (registry: Registry, meta: Metadata, dest: string, extraTypes: ExtraTypes, isStrict: boolean, customLookupDefinitions?: Definitions): void {
          Severity: Minor
          Found in packages/typegen/src/generate/runtime.ts - About 45 mins to fix

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

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

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

                  return generateCallsTypesTemplate({
      headerType: 'chain',
      imports,
      isStrict,
      modules,
              Severity: Major
              Found in packages/typegen/src/generate/runtime.ts and 1 other location - About 5 hrs to fix
              packages/typegen/src/generate/query.ts on lines 119..134

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

              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 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/runtime.ts and 5 other locations - About 2 hrs to fix
              packages/typegen/src/generate/consts.ts on lines 33..35
              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/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

              There are no issues that match your filters.

              Category
              Status