Sign upLogin

secureCodeBox/secureCodeBox

View on GitHub
Star
documentation/src/docs.build.js

Summary

Maintainability
C
1 day
Test Coverage

File docs.build.js has 266 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// SPDX-FileCopyrightText: the secureCodeBox authors
//
// SPDX-License-Identifier: Apache-2.0

const fs = require("fs"),
Severity: Minor
Found in documentation/src/docs.build.js - About 2 hrs to fix

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

    async function getExamples(dir) {
  if (!fs.existsSync(dir)) {
    return [];
  }
    Severity: Major
    Found in documentation/src/docs.build.js - About 2 hrs to fix

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

      async function createDocFilesFromMainRepository(relPath, targetPath, dirNames) {
  for (const dirName of dirNames) {
    const readMe = `${relPath}/${dirName}/README.md`;

    if (!fs.existsSync(readMe)) {
      Severity: Minor
      Found in documentation/src/docs.build.js - About 1 hr to fix

        Function main has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        async function main() {
  const currentDirectory = __dirname; // current directory is /documentation/src
  const parentDirectory = path.dirname(currentDirectory); // parent is /documentation
  const rootDirectory = path.dirname(parentDirectory); // root is /
        Severity: Minor
        Found in documentation/src/docs.build.js - About 1 hr to fix

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

          async function createDocFilesFromMainRepository(relPath, targetPath, dirNames) {
  for (const dirName of dirNames) {
    const readMe = `${relPath}/${dirName}/README.md`;

    if (!fs.existsSync(readMe)) {
          Severity: Minor
          Found in documentation/src/docs.build.js - 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 main has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

          async function main() {
  const currentDirectory = __dirname; // current directory is /documentation/src
  const parentDirectory = path.dirname(currentDirectory); // parent is /documentation
  const rootDirectory = path.dirname(parentDirectory); // root is /
          Severity: Minor
          Found in documentation/src/docs.build.js - 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

          There are no issues that match your filters.

          Category
          Status