mega-linter-runner 8.8.1-beta202507270754.0 → 8.8.1-beta202507271139.0

package/generators/mega-linter-custom-flavor/index.js

@@ -0,0 +1,163 @@
+import { asciiArt } from "../../lib/ascii.js";
+import Generator from 'yeoman-generator';
+import { simpleGit } from 'simple-git';
+import c from 'chalk';
+import fs from "fs"
+import yaml from "js-yaml";
+
+export default class GeneratorMegaLinter extends Generator {
+  async prompting() {
+    console.log(asciiArt());
+    this.log(c.cyan(
+      `Welcome to the MegaLinter Custom Flavor generator !
+When you don't know what option to select, please use default values`
+    ));
+
+    // Verify that the repo name contains "megalinter-custom-flavor"
+    const git = simpleGit();
+    const remote = await git.getRemotes(true);
+    if (!remote[0].refs.fetch.includes("megalinter-custom-flavor")) {
+      const errorMessage = `
+ERROR: This generator must be run in a repository whose name includes 'megalinter-custom-flavor'
+Example: 'megalinter-custom-flavor-python-light'
+`
+      this.log(c.red(c.bold(errorMessage)));
+      throw new Error(errorMessage);
+    }
+    // Fetch https://raw.githubusercontent.com/megalinter/megalinter/main/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json
+    this.log("Fetching MegaLinter configuration schema...");
+    const url = 'https://raw.githubusercontent.com/megalinter/megalinter/main/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json';
+    const response = await fetch(url);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch schema from ${url}`);
+    }
+    const schema = await response.json();
+    const linterKeys = schema.definitions.enum_linter_keys.enum || [];
+
+    let defaultFlavorLabel = "MyCustomFlavor";
+    let defaultSelectedLinters = [];
+    if (globalThis.customFlavorLinters) {
+      // Check if linters are valid , and crash if there is an invalid linter key
+      globalThis.customFlavorLinters.forEach((linter) => {
+        if (!linterKeys.includes(linter)) {
+          throw new Error(`Invalid linter key: ${linter}`);
+        }
+      });
+      defaultSelectedLinters = globalThis.customFlavorLinters;
+    }
+    else {
+      // Initialize data from existing configuration
+      const customFlavorConfigPath = this.destinationPath('megalinter-custom-flavor.yml');
+      if (fs.existsSync(customFlavorConfigPath)) {
+        const customFlavorConfigContent = fs.readFileSync(customFlavorConfigPath, 'utf8');
+        const customFlavorConfig = yaml.load(customFlavorConfigContent);
+        if (customFlavorConfig.label) {
+          defaultFlavorLabel = customFlavorConfig.label;
+        }
+        if (customFlavorConfig.linters) {
+          defaultSelectedLinters = customFlavorConfig.linters.map((linter) => linter.replace(/^\s*-\s*/, '').trim());
+        }
+      }
+    }
+
+    const prompts = [
+      {
+        type: 'input',
+        name: 'customFlavorLabel',
+        message: 'What is the label of your custom flavor?',
+        default: defaultFlavorLabel
+      },
+      {
+        type: 'checkbox',
+        name: 'selectedLinters',
+        message: 'Please select the linters you want to include in your custom flavor:',
+        choices: linterKeys,
+        default: defaultSelectedLinters
+      }
+    ];
+
+    return this.prompt(prompts).then(async (props) => {
+      this.props = props;
+      await this._computeValues();
+    });
+  }
+
+  writing() {
+    this._generateFlavorConfig();
+    this._generateGitHubWorkflow();
+    this._generateGitHubAction();
+    this._generateReadme();
+  }
+
+  end() {
+    this.log("You're all set !");
+    this.log(c.green(
+      "Now commit, push then create a GitHub Release to generate your custom flavor !")
+    );
+  }
+
+  async _computeValues() {
+    // Custom flavor label
+    this.customFlavorLabel = this.props.customFlavorLabel;
+    // Custom flavor selected linters
+    this.selectedLinters = this.props.selectedLinters.map((linter) => `  - ${linter}`).join("\n");
+    // Check at least one linter is selected
+    if (this.selectedLinters.length === 0) {
+      throw new Error("You must select at least one linter for your custom flavor");
+    }
+    // Custom flavor author is git username
+    const git = simpleGit();
+    const user = await git.getConfig('user.name');
+    this.customFlavorAuthor = user.value;
+    // Get remote repo
+    const remote = await git.getRemotes(true);
+    this.customFlavorRepo = remote[0].refs.fetch.replace('https://github.com/', '').replace('.git', '');
+    // Custom flavor docker image version
+    this.customFlavorDockerImageVersion = `ghcr.io/${this.customFlavorRepo}/megalinter-custom-flavor:latest`;
+  }
+
+  _generateFlavorConfig() {
+    this.fs.copyTpl(
+      this.templatePath("megalinter-custom-flavor.yml"),
+      this.destinationPath(`megalinter-custom-flavor.yml`),
+      {
+        CUSTOM_FLAVOR_LABEL: this.customFlavorLabel,
+        CUSTOM_FLAVOR_LINTERS: this.selectedLinters,
+      }
+    );
+  }
+
+  _generateGitHubWorkflow() {
+    this.fs.copyTpl(
+      this.templatePath("megalinter-custom-flavor-builder.yml"),
+      this.destinationPath("./.github/workflows/megalinter-custom-flavor-builder.yml"),
+      {}
+    );
+  }
+
+  _generateGitHubAction() {
+    this.fs.copyTpl(
+      this.templatePath("action.yml"),
+      this.destinationPath("action.yml"),
+      {
+        CUSTOM_FLAVOR_LABEL: this.customFlavorLabel,
+        CUSTOM_FLAVOR_AUTHOR: this.customFlavorAuthor,
+        DOCKER_IMAGE_VERSION: this.customFlavorDockerImageVersion,
+      }
+    );
+  }
+
+  _generateReadme() {
+    this.fs.copyTpl(
+      this.templatePath("README.md"),
+      this.destinationPath("README.md"),
+      {
+        CUSTOM_FLAVOR_LABEL: this.customFlavorLabel,
+        CUSTOM_FLAVOR_LINTERS: this.selectedLinters,
+        DOCKER_IMAGE_VERSION: this.customFlavorDockerImageVersion,
+        CUSTOM_FLAVOR_GITHUB_ACTION: this.customFlavorRepo
+      }
+    );
+  }
+
+}

package/generators/mega-linter-custom-flavor/templates/README.md

@@ -0,0 +1,20 @@
+# MegaLinter Custom Flavor
+
+<%= CUSTOM_FLAVOR_LABEL %>
+
+## Embedded linters
+
+<%= CUSTOM_FLAVOR_LINTERS %>
+
+## How to generate the flavor
+
+Create a GitHub release on your repo, it will generate and publish your custom flavor using the MegaLinter custom Flavor Builder matching the tag name of your release (example: `9.0.0`)
+
+You can also generate a custom flavor using MegaLinter Custom Flavor by pushing on any branch or manually run the workflow `megalinter-custom-flavor-builder.yml`.
+
+## How to use the custom flavor
+
+Follow [MegaLinter installation guide](https://megalinter.io/latest/install-assisted/), and replace related elements in the workflow.
+
+- GitHub Action: On MegaLinter step in .github/workflows/mega-linter.yml, define `uses: <%= CUSTOM_FLAVOR_GITHUB_ACTION %>@main`
+- Docker image: Replace official MegaLinter image by `<%= DOCKER_IMAGE_VERSION %>`

package/generators/mega-linter-custom-flavor/templates/action.yml

@@ -0,0 +1,16 @@
+name: "MegaLinter Custom Flavor: <%= CUSTOM_FLAVOR_LABEL %>"
+author: "<%= CUSTOM_FLAVOR_AUTHOR %>"
+description: "MegaLinter Custom Flavor <%= CUSTOM_FLAVOR_LABEL %>"
+outputs:
+  has_updated_sources:
+    description: "0 if no source file has been updated, 1 if source files has been updated"
+runs:
+  using: "docker"
+  # You can manually update the Docker image version here, or use the latest tag
+  image: "docker://<%= DOCKER_IMAGE_VERSION %>"
+  args:
+    - "-v"
+    - "/var/run/docker.sock:/var/run/docker.sock:rw"
+branding:
+  icon: "check"
+  color: "green"

package/generators/mega-linter-custom-flavor/templates/megalinter-custom-flavor-builder.yml

@@ -0,0 +1,80 @@
+# =============================================================
+# Build MegaLinter Custom Flavor Workflow
+#
+# This workflow builds and publishes a custom MegaLinter Docker image
+# to GitHub Container Registry (ghcr.io) and optionally Docker Hub.
+#
+# Usage:
+# - Triggers on push, release, or manual dispatch.
+# - Tags the image with the release tag (on release) or 'alpha' (otherwise).
+# - Pushes to ghcr.io and, if credentials are set, to Docker Hub.
+#
+# Required repository secrets:
+#   - GITHUB_TOKEN: Provided by GitHub Actions (for ghcr.io push)
+#   - DOCKERHUB_USERNAME: (optional) Docker Hub username for push
+#   - DOCKERHUB_PASSWORD: (optional) Docker Hub password/token for push
+#
+# Optional repository variables:
+#   - DOCKERHUB_REPO: Docker Hub repository name (e.g. nvuillam)
+#
+# The MegaLinter custom flavor image will be available at:
+#   - ghcr.io/<owner>/<repo>:<tag>
+#   - docker.io/<dockerhub_repo>/<repo>:<tag> (if Docker Hub credentials are set)
+# =============================================================
+
+name: Build & Push MegaLinter Custom Flavor
+
+on:
+  push:
+    branches-ignore: [main]
+  release:
+    types: [edited, published]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-custom-flavor:
+    name: Build Custom MegaLinter Flavor
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Log in to Docker Hub only if credentials are provided
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        continue-on-error: true
+
+      - name: Build MegaLinter Custom Flavor
+        uses: oxsecurity/megalinter/flavors/custom-builder@main
+        with:
+          megalinter-custom-flavor-builder-tag: ${{ github.event_name == 'release' && github.event.release.tag_name || 'beta' }}
+          is-latest: ${{ github.event_name == 'release' && 'true' || 'false' }}
+          upload-to-ghcr: "true"
+          upload-to-dockerhub: ${{ secrets.DOCKERHUB_USERNAME != '' && secrets.DOCKERHUB_PASSWORD != '' && 'true' || 'false' }}
+          dockerhub-repo: ${{ vars.DOCKERHUB_REPO }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CUSTOM_FLAVOR_BUILD_REPO: ${{ github.repository }}
+          CUSTOM_FLAVOR_BUILD_REPO_URL: ${{ github.repositoryUrl }}
+          CUSTOM_FLAVOR_BUILD_USER: ${{ github.actor }}

package/generators/mega-linter-custom-flavor/templates/megalinter-custom-flavor.yml

@@ -0,0 +1,6 @@
+# MegaLinter Custom Flavor configuration
+# If you update it manually, run `npx mega-linter-runner --custom-flavor-setup` to propagate updates.
+
+label: <%= CUSTOM_FLAVOR_LABEL %>
+linters:
+<%= CUSTOM_FLAVOR_LINTERS %>

package/lib/options.js

@@ -122,6 +122,17 @@ export const optionsDefinition = optionator.default({
       type: "Boolean",
       description: "Generate MegaLinter configuration in your project",
     },
+    {
+      option: "custom-flavor-setup",
+      alias: "cfs",
+      type: "Boolean",
+      description: "Generate files to create a custom flavor",
+    },
+    {
+      option: "custom-flavor-linters",
+      type: "String",
+      description: "comma-separated list of linters to include in custom flavor",
+    },
     {
       option: "upgrade",
       alias: "u",

package/lib/runner.js

@@ -54,6 +54,21 @@ export class MegaLinterRunner {
       return { status: 0 };
     }
 
+    // Run custom flavor generator
+    if (options.customFlavorSetup) {
+      if (options.customFlavorLinters) {
+        globalThis.customFlavorLinters = options.customFlavorLinters.split(",").map((linter) => linter.trim());
+      }
+      const env = createEnv();
+      const __dirname = dirname(fileURLToPath(import.meta.url));
+      const generatorPath = path.resolve(
+        path.join(__dirname, "..", "generators", "mega-linter-custom-flavor")
+      );
+      console.log("Yeoman generator used: " + generatorPath);
+      env.run(generatorPath);
+      return { status: 0 };
+    }
+
     // Run upgrader from v4 to v5
     if (options.upgrade) {
       const megaLinterUpgrader = new MegaLinterUpgrader();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mega-linter-runner",
-  "version": "8.8.1-beta202507270754.0",
+  "version": "8.8.1-beta202507271139.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/oxsecurity/megalinter.git"
@@ -82,14 +82,16 @@
   "author": "Nicolas Vuillamy",
   "license": "MIT",
   "dependencies": {
-    "chalk": "^5.3.0",
+    "chalk": "^5.4.1",
     "find-package-json": "^1.2.0",
     "fs-extra": "^11.1.1",
     "glob": "^11.0.0",
+    "js-yaml": "^4.1.0",
     "mem-fs": "^4.0.0",
     "open": "^10.0.2",
     "optionator": "^0.9.3",
     "prompts": "^2.4.2",
+    "simple-git": "^3.28.0",
     "uuid": "^11.0.0",
     "which": "^5.0.0",
     "yeoman-environment": "^4.0.0",