Sign upLogin

cityssm/node-faster-report-parser

View on GitHub
Star

Showing 15 of 15 total issues

Consider simplifying this complex logical expression.
Open

      } else if (isDataRow(row)) {
        results.data.at(-1)?.items.push({
          itemNumber: row[0] ?? '',
          itemName: row[1] ?? '',
          binLocation: row[3] ?? '',
Severity: Critical
Found in xlsxReports/inventory/w200.inventory.ts - About 3 hrs to fix

    Function parseFasterCsvReport has 61 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function parseFasterCsvReport<T>(
  pathToCsvFile: string,
  parsingOptions: ParseFasterCsvReportOptions<T>
): Promise<FasterCsvReportResults<T>> {
  // eslint-disable-next-line security/detect-non-literal-fs-filename
    Severity: Major
    Found in csvReports.ts - About 2 hrs to fix

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

      export function parseW311ExcelReport(
  pathToXlsxFile: string
): W311ExcelReportResults {
  const workbook = getXLSXWorkBook(pathToXlsxFile)
      Severity: Major
      Found in xlsxReports/maintenance/w311.activeWorkOrdersByShop.ts - About 2 hrs to fix

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

        export function extractReportMetadata(
  workbook: XLSX.WorkBook,
  options: ExtractReportMetadataOptions
): FasterExcelReportResults {
  const lastSheet = workbook.Sheets[workbook.SheetNames.at(-1) as string]
        Severity: Major
        Found in xlsxReports/helpers.ts - About 2 hrs to fix

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

          export function parseW200ExcelReport(
  pathToXlsxFile: string
): W200ExcelReportResults {
  const workbook = getXLSXWorkBook(pathToXlsxFile)
          Severity: Minor
          Found in xlsxReports/inventory/w200.inventory.ts - About 1 hr to fix

            Function step has 41 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                  step: (row) => {
        const rawRowDataList = row.data as unknown as string[]

        if (headerArray === undefined) {
          headerArray = rawRowDataList
            Severity: Minor
            Found in csvReports.ts - About 1 hr to fix

              Function extractReportMetadata has a Cognitive Complexity of 17 (exceeds 10 allowed). Consider refactoring.
              Open

              export function extractReportMetadata(
  workbook: XLSX.WorkBook,
  options: ExtractReportMetadataOptions
): FasterExcelReportResults {
  const lastSheet = workbook.Sheets[workbook.SheetNames.at(-1) as string]
              Severity: Minor
              Found in xlsxReports/helpers.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 3 locations. Consider refactoring.
              Open

              export type W235ReportRow = Record<
  (typeof w235ColumnReturnNames)[keyof typeof w235ColumnReturnNames],
  string
> &
  Record<
              Severity: Major
              Found in csvReports/inventory/w235.inventorySnapshot.ts and 2 other locations - About 55 mins to fix
              csvReports/inventory/w200s.inventorySummary.ts on lines 21..28
              csvReports/inventory/w223.inventoryTransactionDetails.ts on lines 19..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 54.

              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

              export type W223ReportRow = Record<
  (typeof w223ColumnReturnNames)[keyof typeof w223ColumnReturnNames],
  string
> &
  Record<
              Severity: Major
              Found in csvReports/inventory/w223.inventoryTransactionDetails.ts and 2 other locations - About 55 mins to fix
              csvReports/inventory/w200s.inventorySummary.ts on lines 21..28
              csvReports/inventory/w235.inventorySnapshot.ts on lines 24..31

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

              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

              export type W200SReportRow = Record<
  (typeof w200sColumnReturnNames)[keyof typeof w200sColumnReturnNames],
  string
> &
  Record<
              Severity: Major
              Found in csvReports/inventory/w200s.inventorySummary.ts and 2 other locations - About 55 mins to fix
              csvReports/inventory/w223.inventoryTransactionDetails.ts on lines 19..26
              csvReports/inventory/w235.inventorySnapshot.ts on lines 24..31

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

              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

                        for (const [
            rawParameterColumnName,
            returnParameterColumnName
          ] of Object.entries(
            parsingOptions.columnParameterReturnNames ?? {}
              Severity: Minor
              Found in csvReports.ts and 1 other location - About 50 mins to fix
              csvReports.ts on lines 86..92

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

              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

                        for (const [
            rawVersionColumnName,
            returnVersionColumnName
          ] of Object.entries(parsingOptions.columnVersionReturnNames ?? {})) {
            results.version[returnVersionColumnName] =
              Severity: Minor
              Found in csvReports.ts and 1 other location - About 50 mins to fix
              csvReports.ts on lines 76..84

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

              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 isStoreroomRow(row: XlsxDataRow): boolean {
  return row.length === 17 && (row[0] ?? '').startsWith('STOREROOM: ')
}
              Severity: Minor
              Found in xlsxReports/inventory/w200.inventory.ts and 1 other location - About 45 mins to fix
              xlsxReports/maintenance/w311.activeWorkOrdersByShop.ts on lines 45..47

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

              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 isShopRow(row: XlsxDataRow): boolean {
  return row.length === 10 && (row[0] ?? '').startsWith('WORK ORDER SHOP: ')
}
              Severity: Minor
              Found in xlsxReports/maintenance/w311.activeWorkOrdersByShop.ts and 1 other location - About 45 mins to fix
              xlsxReports/inventory/w200.inventory.ts on lines 41..43

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

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

              export function parseW311ExcelReport(
  pathToXlsxFile: string
): W311ExcelReportResults {
  const workbook = getXLSXWorkBook(pathToXlsxFile)
              Severity: Minor
              Found in xlsxReports/maintenance/w311.activeWorkOrdersByShop.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