Sign upLogin

axe312ger/sqip

View on GitHub
Star

Showing 39 of 39 total issues

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

  async checkForPrimitive(): Promise<undefined> {
    const platform = os.platform()
    const primitivePath = path.join(
      VENDOR_DIR,
      `primitive-${platform}-${os.arch()}${platform === 'win32' ? '.exe' : ''}`
Severity: Major
Found in packages/sqip-plugin-primitive/src/sqip-plugin-primitive.ts and 1 other location - About 1 day to fix
packages/sqip-plugin-triangle/src/sqip-plugin-triangle.ts on lines 216..247

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

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

  async checkForTriangle(): Promise<undefined> {
    const platform = os.platform()
    const trianglePath = path.join(
      VENDOR_DIR,
      `triangle-${platform}-${os.arch()}${platform === 'win32' ? '.exe' : ''}`
Severity: Major
Found in packages/sqip-plugin-triangle/src/sqip-plugin-triangle.ts and 1 other location - About 1 day to fix
packages/sqip-plugin-primitive/src/sqip-plugin-primitive.ts on lines 208..239

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

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

builds.forEach((build) => {
  const { os, arch, filename } = build
  const path = resolve(__dirname, '..', 'primitive-binaries', filename)
  if (existsSync(path)) {
    console.log(`Primitive executable for ${os} (${arch}) already exists`)
Severity: Major
Found in packages/sqip-plugin-primitive/scripts/bundle-vendor.js and 1 other location - About 5 hrs to fix
packages/sqip-plugin-triangle/scripts/bundle-vendor.js on lines 39..51

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

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

builds.forEach((build) => {
  const { os, arch, filename } = build
  const path = resolve(__dirname, '..', 'triangle-binaries', filename)
  if (existsSync(path)) {
    console.log(`Triangle executable for ${os} (${arch}) already exists`)
Severity: Major
Found in packages/sqip-plugin-triangle/scripts/bundle-vendor.js and 1 other location - About 5 hrs to fix
packages/sqip-plugin-primitive/scripts/bundle-vendor.js on lines 39..51

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

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

File sqip.ts has 402 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import path from 'path'

import Debug from 'debug'
import fs from 'fs-extra'
Severity: Minor
Found in packages/sqip/src/sqip.ts - About 5 hrs to fix

    Function processFile has a Cognitive Complexity of 31 (exceeds 5 allowed). Consider refactoring.
    Open

    async function processFile({
  filePath,
  buffer,
  outputFileName,
  config
    Severity: Minor
    Found in packages/sqip/src/sqip.ts - About 4 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 apply has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
    Open

      async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
    Severity: Minor
    Found in packages/sqip-plugin-pixels/src/sqip-plugin-pixels.ts - About 4 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 apply has 97 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
    Severity: Major
    Found in packages/sqip-plugin-pixels/src/sqip-plugin-pixels.ts - About 3 hrs to fix

      Function sqipCLI has 90 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export default async function sqipCLI(): Promise<undefined> {
  const pluginDetectionArgs = commandLineArgs(defaultOptionList, {
    partial: true
  })
      Severity: Major
      Found in packages/sqip-cli/src/sqip-cli.ts - About 3 hrs to fix

        Function cliOptions has 70 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          static get cliOptions(): SqipCliOptionDefinition[] {
    return [
      {
        name: 'color',
        type: String,
        Severity: Major
        Found in packages/sqip-plugin-potrace/src/sqip-plugin-potrace.ts - About 2 hrs to fix

          Function cliOptions has 66 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            static get cliOptions(): SqipCliOptionDefinition[] {
    return [
      { name: 'bl', type: Number, description: 'Blur radius', defaultValue: 2 },
      {
        name: 'nf',
          Severity: Major
          Found in packages/sqip-plugin-triangle/src/sqip-plugin-triangle.ts - About 2 hrs to fix

            Function sqip has 65 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            export async function sqip(
  options: SqipOptions
): Promise<SqipResult | SqipResult[]> {
  // Build configuration based on passed options and default options
  const defaultOptions = {
            Severity: Major
            Found in packages/sqip/src/sqip.ts - About 2 hrs to fix

              Function apply has 60 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
              Severity: Major
              Found in packages/sqip-plugin-potrace/src/sqip-plugin-potrace.ts - About 2 hrs to fix

                Function apply has 60 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                  async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
                Severity: Major
                Found in packages/sqip-plugin-primitive/src/sqip-plugin-primitive.ts - About 2 hrs to fix

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

                    async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
                  Severity: Major
                  Found in packages/sqip-plugin-triangle/src/sqip-plugin-triangle.ts - About 2 hrs to fix

                    Function apply has 55 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                      async apply(
    imageBuffer: Buffer,
    metadata: SqipImageMetadata
  ): Promise<Buffer> {
    if (metadata.type === 'svg') {
                    Severity: Major
                    Found in packages/sqip-plugin-blurhash/src/sqip-plugin-blurhash.ts - About 2 hrs to fix

                      Function cliOptions has 52 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                        static get cliOptions(): SqipCliOptionDefinition[] {
    return [
      {
        name: 'numberOfPrimitives',
        alias: 'n',
                      Severity: Major
                      Found in packages/sqip-plugin-primitive/src/sqip-plugin-primitive.ts - About 2 hrs to fix

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

                        const builds = [
  {
    os: 'darwin',
    arch: 'amd64',
    filename: 'triangle-darwin-x64'
                        Severity: Major
                        Found in packages/sqip-plugin-triangle/scripts/bundle-vendor.js and 1 other location - About 2 hrs to fix
                        packages/sqip-plugin-primitive/scripts/bundle-vendor.js on lines 5..26

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

                        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

                        const builds = [
  {
    os: 'darwin',
    arch: 'amd64',
    filename: 'primitive-darwin-x64'
                        Severity: Major
                        Found in packages/sqip-plugin-primitive/scripts/bundle-vendor.js and 1 other location - About 2 hrs to fix
                        packages/sqip-plugin-triangle/scripts/bundle-vendor.js on lines 5..26

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

                        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

                        Function findBackgroundColor has 49 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                        export async function findBackgroundColor(imageBuffer: Buffer): Promise<string> {
  const image = sharp(imageBuffer)
  const { width, height } = await image.metadata()

  if (!width || !height) {
                        Severity: Minor
                        Found in packages/sqip/src/helpers.ts - About 1 hr to fix
                          Severity
                          Category
                          Status
                          Source
                          Language