Sign upLogin

phodal/adr

View on GitHub
Star

Showing 21 of 21 total issues

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

function generateAsciidocToc (options?: {output: boolean}) {
  let path = Config.getSavePath()
  let graphGenerate = new GenerateBuilder(path)
  let header = '.' + getI18n().tocHeader + '\n'
  let results = graphGenerate
Severity: Major
Found in src/lib/generate.ts and 1 other location - About 5 hrs to fix
src/lib/generate.ts on lines 25..39

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

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

function generateToc (options?: {output: boolean}) {
  let path = Config.getSavePath()
  let graphGenerate = new GenerateBuilder(path)
  let header = '# ' + getI18n().tocHeader + '\n'
  let results = graphGenerate
Severity: Major
Found in src/lib/generate.ts and 1 other location - About 5 hrs to fix
src/lib/generate.ts on lines 41..55

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

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

let getAllFilesName = function (): string[] {
  let outputArray = ['']
  let files = getAdrFiles()
  files.forEach(function (file) {
    let fileName = file.relativePath
Severity: Major
Found in src/lib/status.ts and 1 other location - About 3 hrs to fix
src/lib/logs.ts on lines 10..23

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

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

let getAllFilesName = function (): string[] {
  let outputArray = ['']
  let files = getAdrFiles()
  files.forEach(function (file) {
    let fileName = file.relativePath
Severity: Major
Found in src/lib/logs.ts and 1 other location - About 3 hrs to fix
src/lib/status.ts on lines 11..24

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

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

    for (let i = 0; i < this.bodyString.length; i++) {
      let currentBodyString = this.bodyString[i]
      if (currentBodyString) {
        results.push(currentBodyString)
      }
Severity: Major
Found in src/lib/base/JsonGenerateBuilder.ts and 1 other location - About 1 hr to fix
src/lib/base/GenerateBuilder.ts on lines 61..66

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

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

      for (let i = 0; i < this.bodyString.length; i ++) {
        let currentBodyString = this.bodyString[i]
        if (currentBodyString) {
          results.push(currentBodyString)
        }
Severity: Major
Found in src/lib/base/GenerateBuilder.ts and 1 other location - About 1 hr to fix
src/lib/base/JsonGenerateBuilder.ts on lines 6..11

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

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

function setStatus (filePath, status) {
  let fileData
  let fileExt = Config.getDocExtension()
  try {
    fileData = fs.readFileSync(filePath, 'utf8')
Severity: Minor
Found in src/lib/StatusHelper.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 getAllStatus has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function getAllStatus (filePath): string[] {
  let fileData
  let statusSections
  let status
  let fileExt = Config.getDocExtension()
Severity: Minor
Found in src/lib/StatusHelper.ts - About 1 hr to fix

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

    function updateNameByTitle (): void {
  let files = getAdrFiles()

  files.forEach(function (file) {
    let fileName = file.relativePath
    Severity: Minor
    Found in src/lib/update.ts - About 1 hr to fix

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

      export function compress () {
  let assetsPath = Config.getAssetsPath()

  if (!fs.existsSync(assetsPath)) {
    // TODO notify the user that no assets were found
      Severity: Minor
      Found in src/lib/compress.ts - About 1 hr to fix

        Function getStatusSection has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

        function getStatusSection (tree: any) {
  let statusFlag = false
  let statusSection: string[] = []
  for (let i = 0; i < tree.length; i++) {
    let node = tree[i]
        Severity: Minor
        Found in src/lib/StatusHelper.ts - About 55 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

        Consider simplifying this complex logical expression.
        Open

              if ((fileName === 'README.md' || fileName.indexOf('.md') === -1)
        && (fileName === 'README.adoc' || fileName.indexOf('.adoc') === -1)
        && (fileName === 'README.asciidoc' || fileName.indexOf('.asciidoc') === -1)) {
        return
      }
        Severity: Major
        Found in src/lib/output/HtmlBuilder.ts - About 40 mins to fix

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

          function buildGraphBuildFun (index, decision, file, bodyString, filesLength): string[] {
          Severity: Minor
          Found in src/lib/generate.ts - About 35 mins to fix

            Function build has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

              build () {
    if (typeof this.startString === 'string') {
      return this.startString + this.bodyString.join('') + this.endString
    }
    if (typeof this.startString === 'object') {
            Severity: Minor
            Found in src/lib/base/GenerateBuilder.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

            Function getAllStatus has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

            function getAllStatus (filePath): string[] {
  let fileData
  let statusSections
  let status
  let fileExt = Config.getDocExtension()
            Severity: Minor
            Found in src/lib/StatusHelper.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

            missing whitespace
            Open

                  let fileExtLength = ('.'+fileExt).length
            Severity: Minor
            Found in src/lib/base/GenerateBuilder.ts by tslint

            Rule: whitespace

            Enforces whitespace style conventions.

            Rationale

            Helps maintain a readable, consistent style in your codebase.

            Notes
            • Has Fix

            Config

            Several arguments may be optionally provided:

            • "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
            • "check-decl"checks that variable declarations have whitespace around the equals token.
            • "check-operator" checks for whitespace around operator tokens.
            • "check-module" checks for whitespace in import & export statements.
            • "check-separator" checks for whitespace after separator tokens (,/;).
            • "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
            • "check-type" checks for whitespace before a variable type specification.
            • "check-typecast" checks for whitespace between a typecast and its target.
            • "check-type-operator" checks for whitespace between type operators | and &.
            • "check-preblock" checks for whitespace before the opening brace of a block.
            • "check-postbrace" checks for whitespace after an opening brace.
            Examples
            "whitespace": true,check-branch,check-operator,check-typecast
            Schema
            {
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

            For more information see this page.

            missing whitespace
            Open

                  let fileExtLength = ('.'+fileExt).length
            Severity: Minor
            Found in src/lib/base/GenerateBuilder.ts by tslint

            Rule: whitespace

            Enforces whitespace style conventions.

            Rationale

            Helps maintain a readable, consistent style in your codebase.

            Notes
            • Has Fix

            Config

            Several arguments may be optionally provided:

            • "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
            • "check-decl"checks that variable declarations have whitespace around the equals token.
            • "check-operator" checks for whitespace around operator tokens.
            • "check-module" checks for whitespace in import & export statements.
            • "check-separator" checks for whitespace after separator tokens (,/;).
            • "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
            • "check-type" checks for whitespace before a variable type specification.
            • "check-typecast" checks for whitespace between a typecast and its target.
            • "check-type-operator" checks for whitespace between type operators | and &.
            • "check-preblock" checks for whitespace before the opening brace of a block.
            • "check-postbrace" checks for whitespace after an opening brace.
            Examples
            "whitespace": true,check-branch,check-operator,check-typecast
            Schema
            {
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

            For more information see this page.

            A space is required before '}'
            Open

              let contentHtml = asciidoctor.convert(fileData, { 'safe': 'safe', 'standalone': true, 'attributes': [ 'toc' ]})
            Severity: Minor
            Found in src/lib/helpers/AsciidocHelper.ts by tslint

            Rule: object-curly-spacing

            No description is given

            Schema
            {}

            For more information see this page.

            " should be '
            Open

              return htmlRender("", contentHtml)
            Severity: Minor
            Found in src/lib/helpers/AsciidocHelper.ts by tslint

            Rule: quotemark

            Enforces quote character for string literals.

            Notes
            • Has Fix

            Config

            Five arguments may be optionally provided:

            • "single" enforces single quotes.
            • "double" enforces double quotes.
            • "backtick" enforces backticks.
            • "jsx-single" enforces single quotes for JSX attributes.
            • "jsx-double" enforces double quotes for JSX attributes.
            • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
            • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
            Examples
            "quotemark": true,single,avoid-escape,avoid-template
            "quotemark": true,single,jsx-double
            Schema
            {
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

            For more information see this page.

            trailing whitespace
            Open
            Severity: Minor
            Found in src/lib/helpers/AsciidocHelper.ts by tslint

            Rule: no-trailing-whitespace

            Disallows trailing whitespace at the end of a line.

            Rationale

            Keeps version control diffs clean as it prevents accidental whitespace from being committed.

            Notes
            • Has Fix

            Config

            Possible settings are:

            • "ignore-template-strings": Allows trailing whitespace in template strings.
            • "ignore-comments": Allows trailing whitespace in comments.
            • "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
            • "ignore-blank-lines": Allows trailing whitespace on empty lines.
            Examples
            "no-trailing-whitespace": true
            "no-trailing-whitespace": true,ignore-comments
            "no-trailing-whitespace": true,ignore-jsdoc
            Schema
            {
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

            For more information see this page.

            Severity
            Category
            Status
            Source
            Language