Sign upLogin

sparkletown/sparkle

View on GitHub
Star
scripts/lib/bot.ts

Summary

Maintainability
F
6 days
Test Coverage

File bot.ts has 451 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { strict as assert } from "assert";

import chalk from "chalk";
import * as faker from "faker";
import admin from "firebase-admin";
Severity: Minor
Found in scripts/lib/bot.ts - About 6 hrs to fix

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

) => Promise<void> = async (options) => {
  const { userRef, user, venueRef, stats, log, pos, sovereignVenue } = options;
  const { sectionId, row, col } = pos;

  const venueId = venueRef.id;
Severity: Minor
Found in scripts/lib/bot.ts - About 1 hr to fix

Function addBotReaction has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

) => Promise<void> = async (options) => {
  const { reactionsRef, userRef, conf, log, stats } = options;
  const snap = await userRef.get();
  assert.ok(
    snap.exists,
Severity: Minor
Found in scripts/lib/bot.ts - About 1 hr to fix

Function sendBotVenueMessage has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

) => Promise<void> = async (options) => {
  const { chatsRef, userRef, venueRef, conf, log, stats } = options;
  const snap = await userRef.get();
  assert.ok(
    snap.exists,
Severity: Minor
Found in scripts/lib/bot.ts - About 1 hr to fix

Function takeSeatAtTable has 33 lines of code (exceeds 25 allowed). Consider refactoring.
Open

) => Promise<void> = async (options) => {
  const {
    userRef,
    user,
    venueId,
Severity: Minor
Found in scripts/lib/bot.ts - About 1 hr to fix

Function removeBotChatMessages has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

) => Promise<void> = async ({ chatsRef, conf, log, stats }) => {
  const remove = withErrorReporter(conf.log, (chatRef: DocumentReference) => {
    const promise = chatRef.delete();
    promise.then(() => {
      log(
Severity: Minor
Found in scripts/lib/bot.ts - 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 removeBotReactions has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

) => Promise<void> = async ({ reactionsRef, conf, log, stats }) => {
  const remove = withErrorReporter(
    conf.log,
    (reactionRef: DocumentReference) => {
      const promise = reactionRef.delete();
Severity: Minor
Found in scripts/lib/bot.ts - 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

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

export const removeBotReactions: (
  options: SimContext<"reactionsRef" | "conf" | "log" | "stats">
) => Promise<void> = async ({ reactionsRef, conf, log, stats }) => {
  const remove = withErrorReporter(
    conf.log,
Severity: Major
Found in scripts/lib/bot.ts and 1 other location - About 2 days to fix
scripts/lib/bot.ts on lines 496..537

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

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 const removeBotChatMessages: (
  options: SimContext<"chatsRef" | "conf" | "log" | "stats">
) => Promise<void> = async ({ chatsRef, conf, log, stats }) => {
  const remove = withErrorReporter(conf.log, (chatRef: DocumentReference) => {
    const promise = chatRef.delete();
Severity: Major
Found in scripts/lib/bot.ts and 1 other location - About 2 days to fix
scripts/lib/bot.ts on lines 390..436

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

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

  const {
    userRef,
    user,
    venueId,
    venueName,
Severity: Major
Found in scripts/lib/bot.ts and 2 other locations - About 1 hr to fix
src/components/organisms/NewProfileModal/EditingProfileModalContent/EditingProfileModalContent.tsx on lines 60..77
src/components/templates/Auditorium/components/Section/Section.tsx on lines 61..80

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

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

  assert.ok(
    user?.bot === true,
    chalk`${sendBotVenueMessage.name}(): user is required and has to be a bot ({magenta user.bot}: {blueBright ${user?.bot})}`
  );
Severity: Minor
Found in scripts/lib/bot.ts and 1 other location - About 30 mins to fix
scripts/lib/bot.ts on lines 348..351

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

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

  assert.ok(
    user?.bot === true,
    chalk`${addBotReaction.name}(): user is required and has to be a bot ({magenta user.bot}: {blueBright ${user?.bot})}`
  );
Severity: Minor
Found in scripts/lib/bot.ts and 1 other location - About 30 mins to fix
scripts/lib/bot.ts on lines 453..456

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

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