mega-linter-runner/generators/mega-linter/index.js

Local runner for MegaLinter

import { asciiArt } from "../../lib/ascii.js";
import Generator from 'yeoman-generator';
import { OXSecuritySetup } from "../../lib/ox-setup.js";
import { DEFAULT_RELEASE } from "../../lib/config.js";

export default class GeneratorMegaLinter extends Generator {
  prompting() {
    console.log(asciiArt());
    this.log(
      `Welcome to the MegaLinter configuration generator !
When you don't know what option to select, please use default values`
    );

    const prompts = [
      {
        type: "list",
        name: "flavor",
        message: "What is your project type ?",
        default: "all",
        choices: [
          {
            value: "all",
            name: "Let MegaLinter suggest to me later (recommended)",
          },
          { value: "dart", name: "Dart" },
          { value: "documentation", name: "Documentation" },
          { value: "dotnet", name: "C, C++, C# or Visual Basic.net" },
          { value: "go", name: "Go" },
          { value: "java", name: "Java / Groovy / Kotlin" },
          { value: "javascript", name: "Javascript / Typescript" },
          { value: "php", name: "PHP" },
          { value: "python", name: "Python" },
          { value: "ruby", name: "Ruby" },
          { value: "rust", name: "RUST" },
          { value: "salesforce", name: "Salesforce" },
          { value: "scala", name: "Scala" },
          { value: "swift", name: "Swift" },
          { value: "terraform", name: "Terraform" },
        ],
      },
      {
        type: "list",
        name: "ci",
        message: "What CI/CD system do you use ?",
        default: "gitHubActions",
        choices: [
          { name: "GitHub Actions", value: "gitHubActions" },
          { name: "GitLab CI", value: "gitLabCI" },
          { name: "Azure Pipelines", value: "azure" },
          { name: "Bitbucket Pipelines", value: "bitbucket" },
          { name: "Jenkins", value: "jenkins" },
          { name: "Drone CI", value: "droneCI" },
          { name: "Concourse CI", value: "concourse" },
          { name: "Other, I will install workflow manually", value: "other" },
        ],
      },
      {
        type: "confirm",
        name: "copyPaste",
        message: "Do you want to detect excessive copy-pastes ?",
        default: true,
      },
      {
        type: "confirm",
        name: "spellingMistakes",
        message: "Do you want to detect spelling mistakes ?",
        default: true,
      },
      {
        type: "list",
        name: "version",
        message: "Which MegaLinter version do you want to use ?",
        default: DEFAULT_RELEASE,
        choices: [
          { name: `${DEFAULT_RELEASE} (Latest official release)`, value: DEFAULT_RELEASE },
          {
            name: "Beta (main branch of MegaLinter repository)",
            value: "beta",
          },
        ],
      },
      {
        type: "list",
        name: "defaultBranch",
        message: "What is the name of your repository default branch ?",
        default: "main",
        choices: [
          { name: "master", value: "master" },
          { name: "main", value: "main" },
        ],
      },
      {
        type: "list",
        name: "validateAllCodeBase",
        message:
          "Do you want MegaLinter to validate all source code or only updated one ?",
        default: "all",
        choices: [
          { name: "Validate all sources", value: "all" },
          {
            name: "Validate only sources diff with master/main branch",
            value: "diff",
          },
        ],
      },
      {
        type: "confirm",
        name: "applyFixes",
        message:
          "Do you want to automatically apply formatting and auto-fixes (--fix option of linters) ?",
        default: true,
      },
      {
        type: "confirm",
        name: "ox",
        message:
          "Do you want to additionally visit OX Security (https://www.ox.security/?ref=megalinter) to secure your software supply chain security ?",
        default: true,
      },
    ];

    return this.prompt(prompts).then((props) => {
      this.props = props;
      this._computeValues();
    });
  }

  writing() {
    // Generate workflow config
    this._generateGitHubAction();
    this._generateGitLabCi();
    this._generateAzurePipelines();
    this._generateBitbucketPipelines();
    this._generateJenkinsfile();
    this._generateDroneCI();
    this._generateConcourseCI();
    if (this.props.ci === "other") {
      this.log(
        "Please follow manual instructions to define CI job at https://megalinter.io/installation/"
      );
      this.log(
        "You may call `npx mega-linter-runner` to run MegaLinter from any system (requires node.js & docker)"
      );
    }
    // Generate .mega-linter.yml config
    this._generateMegaLinterConfig();
    // Generate .cspell.json config
    this._generateCSpellConfig();
    // Generate .jscpd.json config
    this._generateJsCpdConfig();
    // Create/update .gitignore
    this._manageGitIgnore();
    // Process linking to ox.security service
    if (this.props.ox === true) {
      new OXSecuritySetup().run();
    }
  }

  end() {
    this.log("You're all set !");
    this.log(
      "Now commit, push and create a pull request to see MegaLinter catching errors !"
    );
  }

  _computeValues() {
    // Flavor
    if (this.props.flavor === "all") {
      this.gitHubActionName = "oxsecurity/megalinter";
      this.dockerImageName = "oxsecurity/megalinter";
    } else {
      this.gitHubActionName =
        "oxsecurity/megalinter/flavors/" + this.props.flavor;
      this.dockerImageName = "oxsecurity/megalinter-" + this.props.flavor;
    }
    // Version
    if (this.props.version == DEFAULT_RELEASE) {
      this.gitHubActionVersion = DEFAULT_RELEASE;
      this.dockerImageVersion = DEFAULT_RELEASE;
    } else {
      this.gitHubActionVersion = "beta";
      this.dockerImageVersion = "beta";
    }
    // VALIDATE_ALL_CODE_BASE
    if (this.props.validateAllCodeBase === "all") {
      this.validateAllCodeBaseGha = "true";
    } else {
      this.validateAllCodeBaseGha  = ">-\n"
      this.validateAllCodeBaseGha += "            ${{";
      this.validateAllCodeBaseGha += "              github.event_name == 'push' &&"
      this.validateAllCodeBaseGha += "              github.ref == 'refs/heads/main'"
      this.validateAllCodeBaseGha += "            }}";
    }
    // persist-credentials
    if (this.props.applyFixes === true) {
      this.persistCredentials =
        "# persist-credentials: false # Comment this line and uncomment the next one if you use APPLY_FIXES\n          persist-credentials: true # zizmor: ignore[artipacked]";
    } else {
      this.persistCredentials =
        "persist-credentials: false # Comment this line and uncomment the next one if you use APPLY_FIXES\n          # persist-credentials: true # zizmor: ignore[artipacked]";
    }
    this.disable = false;
    // COPY PASTES
    if (this.props.copyPaste === true) {
      this.configCopyPaste =
        "# - COPYPASTE # Uncomment to disable checks of excessive copy-pastes";
    } else {
      this.configCopyPaste =
        "- COPYPASTE # Comment to enable checks of excessive copy-pastes";
      this.disable = true;
    }
    // Spelling mistakes
    if (this.props.spellingMistakes === true) {
      this.configSpell =
        "# - SPELL # Uncomment to disable checks of spelling mistakes";
    } else {
      this.configSpell =
        "- SPELL # Comment to enable checks of spelling mistakes";
      this.disable = true;
    }
  }

  _generateGitHubAction() {
    if (this.props.ci !== "gitHubActions") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath("mega-linter.yml"),
      this.destinationPath("./.github/workflows/mega-linter.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        GITHUB_ACTION_NAME: this.gitHubActionName,
        GITHUB_ACTION_VERSION: this.gitHubActionVersion,
        PERSIST_CREDENTIALS: this.persistCredentials,
        VALIDATE_ALL_CODE_BASE_GHA: this.validateAllCodeBaseGha,
      }
    );
  }
  _generateDroneCI() {
    if (this.props.ci !== "droneCI") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath(".drone.yml"),
      this.destinationPath(".drone.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }
  _generateJenkinsfile() {
    if (this.props.ci !== "jenkins") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath("Jenkinsfile"),
      this.destinationPath("Jenkinsfile"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }

  _generateGitLabCi() {
    if (this.props.ci !== "gitLabCI") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath(".gitlab-ci.yml"),
      this.destinationPath(".gitlab-ci.yml"),
      {
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }

  _generateAzurePipelines() {
    if (this.props.ci !== "azure") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath("azure-pipelines.yml"),
      this.destinationPath("azure-pipelines.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }

  _generateBitbucketPipelines() {
    if (this.props.ci !== "bitbucket") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath("bitbucket-pipelines.yml"),
      this.destinationPath("bitbucket-pipelines.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }

  _generateConcourseCI() {
    if (this.props.ci !== "concourse") {
      return;
    }
    this.fs.copyTpl(
      this.templatePath("concourse-task.yml"),
      this.destinationPath("concourse-task.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DOCKER_IMAGE_NAME: this.dockerImageName,
        DOCKER_IMAGE_VERSION: this.dockerImageVersion,
      }
    );
  }

  _generateMegaLinterConfig() {
    this.fs.copyTpl(
      this.templatePath(".mega-linter.yml"),
      this.destinationPath(".mega-linter.yml"),
      {
        APPLY_FIXES: this.props.applyFixes === true ? "all" : "none",
        DEFAULT_BRANCH: this.props.defaultBranch,
        DISABLE: this.disable === true ? "DISABLE:" : "# DISABLE:",
        COPYPASTE: this.configCopyPaste,
        SPELL: this.configSpell
      }
    );
  }

  _generateCSpellConfig() {
    if (this.props.spellingMistakes !== true) {
      return;
    }
    this.fs.copyTpl(
      this.templatePath(".cspell.json"),
      this.destinationPath(".cspell.json"),
      {}
    );
  }

  _generateJsCpdConfig() {
    if (this.props.copyPaste !== true) {
      return;
    }
    this.fs.copyTpl(
      this.templatePath(".jscpd.json"),
      this.destinationPath(".jscpd.json"),
      {}
    );
  }

  // Create or update .gitignore files
  _manageGitIgnore() {
    const gitIgnoreFile = this.destinationPath(".gitignore");
    let gitIgnoreTextLines = [];
    let doWrite = false;
    if (this.fs.exists(gitIgnoreFile)) {
      gitIgnoreTextLines = this.fs.read(gitIgnoreFile).split(/\r?\n/);
    }
    if (!gitIgnoreTextLines.includes("megalinter-reports/")) {
      gitIgnoreTextLines.push("megalinter-reports/");
      doWrite = true;
    }
    if (doWrite) {
      this.fs.write(gitIgnoreFile, gitIgnoreTextLines.join("\n") + "\n");
      this.log(
        "Updated .gitignore file to exclude megalinter-reports from commits"
      );
    }
  }
}