polkadot-js/api

View on GitHub
packages/typegen/src/fromChain.ts

Summary

Maintainability
C
1 day
Test Coverage

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

async function generate (metaHex: HexString, pkg: string | undefined, output: string, isStrict?: boolean): Promise<void> {
  console.log(`Generating from metadata, ${formatNumber((metaHex.length - 2) / 2)} bytes`);

  const outputPath = assertDir(path.join(process.cwd(), output));
  let extraTypes: Record<string, any> = {};
Severity: Minor
Found in packages/typegen/src/fromChain.ts - About 1 hr to fix

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

    async function mainPromise (): Promise<void> {
      const { endpoint, output, package: pkg, strict: isStrict } = yargs(hideBin(process.argv)).strict().options({
        endpoint: {
          description: 'The endpoint to connect to (e.g. wss://kusama-rpc.polkadot.io) or relative path to a file containing the JSON output of an RPC state_getMetadata call',
          required: true,
    Severity: Minor
    Found in packages/typegen/src/fromChain.ts - About 1 hr to fix

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

        if (endpoint.startsWith('wss://') || endpoint.startsWith('ws://')) {
          metaHex = await getMetadataViaWs(endpoint);
        } else {
          metaHex = (
            JSON.parse(
      Severity: Major
      Found in packages/typegen/src/fromChain.ts and 1 other location - About 4 hrs to fix
      packages/typegen/src/fromDefs.ts on lines 81..93

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

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

      export function main (): void {
        mainPromise().catch((error) => {
          console.error();
          console.error(error);
          console.error();
      Severity: Major
      Found in packages/typegen/src/fromChain.ts and 2 other locations - About 2 hrs to fix
      packages/typegen/src/fromDefs.ts on lines 99..106
      packages/typegen/src/metadataMd.ts on lines 526..533

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

      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