Sign upLogin

JiPaix/dotenv-manipulator

View on GitHub
Star

Showing 7 of 7 total issues

Function remove has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

  public remove(obj: { [x: string]: string } | string | string[]): TypeError | undefined {
    if (typeof obj === 'string') {
      delete process.env[obj]
      delete this.env[obj]
    } else if (Object.prototype.toString.call(obj) === '[object Object]') {
Severity: Minor
Found in index.ts - About 1 hr 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

    } else {
      const errorMessage = new TypeError(
        `[REMOVE_ERROR]: expected [object Object] or [object Array] or [String] but received ${Object.prototype.toString.call(
          obj
        )}`
Severity: Major
Found in index.ts and 1 other location - About 1 hr to fix
index.ts on lines 134..143

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

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

    if (Object.prototype.toString.call(obj) !== '[object Object]') {
      const errorMessage = new TypeError(
        `[ADD_ERROR]: object must be [object Object] but received ${Object.prototype.toString.call(obj)}`
      )
      if (this.throwable) {
Severity: Major
Found in index.ts and 1 other location - About 1 hr to fix
index.ts on lines 187..198

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

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 __readSync has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

  private __readSync() {
    const OBJ: {
      [x: string]: string
    } = {}
    const file = fs.readFileSync(this.env_path, { encoding: this.encoding }).toString().split(/\r?\n/)
Severity: Minor
Found in index.ts - About 1 hr 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 remove has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public remove(obj: { [x: string]: string } | string | string[]): TypeError | undefined {
    if (typeof obj === 'string') {
      delete process.env[obj]
      delete this.env[obj]
    } else if (Object.prototype.toString.call(obj) === '[object Object]') {
Severity: Minor
Found in index.ts - About 1 hr to fix

    Function add has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      public add(obj: { [x: string]: string }, force = false): TypeError | undefined {
    if (Object.prototype.toString.call(obj) !== '[object Object]') {
      const errorMessage = new TypeError(
        `[ADD_ERROR]: object must be [object Object] but received ${Object.prototype.toString.call(obj)}`
      )
    Severity: Minor
    Found in index.ts - About 45 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 __save has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      private __save() {
    this.__sort()
    let string = ''
    for (const key in this.env) {
      if (Object.prototype.hasOwnProperty.call(this.env, key)) {
    Severity: Minor
    Found in index.ts - About 35 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

    Severity
    Category
    Status
    Source
    Language