way_of_working-code_linting-hdi 1.0.0

data/docs/way_of_working/code-linting/linters.md

@@ -0,0 +1,153 @@
+---
+layout: page
+nav_order: 1
+parent: Code Linting
+---
+
+# Linters
+
+The following tables detail the linters that we are currently using:
+
+## Languages
+
+| Language     | Linter                                | Details                                                                         |
+|:-------------|:--------------------------------------|:--------------------------------------------------------------------------------|
+| Bash         | BASH_EXEC                             | [bash-exec](https://megalinter.io/latest/descriptors/bash_bash_exec/)           |
+| Bash         | BASH_SHELLCHECK                       | [shellcheck](https://megalinter.io/latest/descriptors/bash_shellcheck/)         |
+| Bash         | BASH_SHFMT                            | [shfmt](https://megalinter.io/latest/descriptors/bash_shfmt/)                   |
+| C            | C_CLANG_FORMAT                        | [clang-format](https://megalinter.io/latest/descriptors/c_clang_format/)        |
+| C            | C_CPPLINT                             | [cpplint](https://megalinter.io/latest/descriptors/c_cpplint/)                  |
+| C#           | CSHARP_CSHARPIER                      | [csharpier](https://megalinter.io/latest/descriptors/csharp_csharpier/)         |
+| C#           | CSHARP_DOTNET_FORMAT                  | [dotnet-format](https://megalinter.io/latest/descriptors/csharp_dotnet_format/) |
+| C#           | CSHARP_ROSLYNATOR                     | [roslynator](https://megalinter.io/latest/descriptors/csharp_roslynator/)       |
+| C++          | CPP_CLANG_FORMAT                      | [clang-format](https://megalinter.io/latest/descriptors/cpp_clang_format/)      |
+| C++          | CPP_CPPLINT                           | [cpplint](https://megalinter.io/latest/descriptors/cpp_cpplint/)                |
+| Clojure      | ~~CLOJURE_CLJSTYLE~~                  | Not Used                                                                        |
+| Clojure      | ~~CLOJURE_CLJ_KONDO~~                 | Not Used                                                                        |
+| CoffeeScript | COFFEE_COFFEELINT                     | [coffeelint](https://megalinter.io/latest/descriptors/coffee_coffeelint/)       |
+| Dart         | DART_DARTANALYZER                     | [dartanalyzer](https://megalinter.io/latest/descriptors/dart_dartanalyzer/)     |
+| Go           | GO_GOLANGCI_LINT                      | [golangci-lint](https://megalinter.io/latest/descriptors/go_golangci_lint/)     |
+| Go           | GO_REVIVE                             | [revive](https://megalinter.io/latest/descriptors/go_revive/)                   |
+| Groovy       | ~~GROOVY_NPM_GROOVY_LINT~~            | Not Used                                                                        |
+| Java         | JAVA_CHECKSTYLE                       | [checkstyle](https://megalinter.io/latest/descriptors/java_checkstyle/)         |
+| Java         | JAVA_PMD                              | [pmd](https://megalinter.io/latest/descriptors/java_pmd/)                       |
+| JavaScript   | JAVASCRIPT_ES                         | [eslint](https://megalinter.io/latest/descriptors/javascript_eslint/)           |
+| JavaScript   | ~~JAVASCRIPT_PRETTIER~~               | Not Used                                                                        |
+| JavaScript   | JAVASCRIPT_STANDARD                   | [standard](https://megalinter.io/latest/descriptors/javascript_standard/)       |
+| JSX          | JSX_ESLINT                            | [eslint](https://megalinter.io/latest/descriptors/jsx_eslint/)                  |
+| Kotlin       | KOTLIN_DETEKT                         | [detekt](https://megalinter.io/latest/descriptors/kotlin_detekt/)               |
+| Kotlin       | KOTLIN_KTLINT                         | [ktlint](https://megalinter.io/latest/descriptors/kotlin_ktlint/)               |
+| Lua          | ~~LUA_LUACHECK~~                      | Not Used                                                                        |
+| Lua          | ~~LUA_SELENE~~                        | Not Used                                                                        |
+| Lua          | ~~LUA_STYLUA~~                        | Not Used                                                                        |
+| Makefile     | MAKEFILE_CHECKMAKE                    | [checkmake](https://megalinter.io/latest/descriptors/makefile_checkmake/)       |
+| Perl         | ~~PERL_PERLCRITIC~~                   | Not Used                                                                        |
+| PHP          | ~~PHP_PHPCS~~                         | Not Used                                                                        |
+| PHP          | ~~PHP_PHPCSFIXER~~                    | Not Used                                                                        |
+| PHP          | ~~PHP_PHPLINT~~                       | Not Used                                                                        |
+| PHP          | ~~PHP_PHPSTAN~~                       | Not Used                                                                        |
+| PHP          | ~~PHP_PSALM~~                         | Not Used                                                                        |
+| Powershell   | ~~POWERSHELL_POWERSHELL~~             | Not Used                                                                        |
+| Powershell   | ~~POWERSHELL_POWERSHELL_FORMATTER~~   | Not Used                                                                        |
+| Python       | PYTHON_BANDIT                         | [bandit](https://megalinter.io/latest/descriptors/python_bandit/)               |
+| Python       | PYTHON_BLACK                          | [black](https://megalinter.io/latest/descriptors/python_black/)                 |
+| Python       | PYTHON_FLAKE8                         | [flake8](https://megalinter.io/latest/descriptors/python_flake8/)               |
+| Python       | PYTHON_ISORT                          | [isort](https://megalinter.io/latest/descriptors/python_isort/)                 |
+| Python       | PYTHON_MYPY                           | [mypy](https://megalinter.io/latest/descriptors/python_mypy/)                   |
+| Python       | PYTHON_PYLINT                         | [pylint](https://megalinter.io/latest/descriptors/python_pylint/)               |
+| Python       | PYTHON_PYRIGHT                        | [pyright](https://megalinter.io/latest/descriptors/python_pyright/)             |
+| Python       | PYTHON_RUFF                           | [ruff](https://megalinter.io/latest/descriptors/python_ruff/)                   |
+| R            | R_LINTR                               | [lintr](https://megalinter.io/latest/descriptors/r_lintr/)                      |
+| Raku         | ~~RAKU_RAKU~~                         | Not Used                                                                        |
+| Ruby         | ~~RUBY_RUBOCOP~~                      | Not Used (RuboCop is used directly)                                             |
+| Rust         | RUST_CLIPPY                           | [clippy](https://megalinter.io/latest/descriptors/rust_clippy/)                 |
+| Salesforce   | ~~SALESFORCE_LIGHTNING_FLOW_SCANNER~~ | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_APEX~~      | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_AURA~~      | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_LWC~~       | Not Used                                                                        |
+| Scala        | SCALA_SCALAFIX                        | [scalafix](https://megalinter.io/latest/descriptors/scala_scalafix/)            |
+| SQL          | SQL_SQLFLUFF                          | [sqlfluff](https://megalinter.io/latest/descriptors/sql_sqlfluff/)              |
+| SQL          | SQL_TSQLLINT                          | [tsqllint](https://megalinter.io/latest/descriptors/sql_tsqllint/)              |
+| Swift        | SWIFT_SWIFTLINT                       | [swiftlint](https://megalinter.io/latest/descriptors/swift_swiftlint/)          |
+| TSX          | TSX_ESLINT                            | [eslint](https://megalinter.io/latest/descriptors/tsx_eslint/)                  |
+| TypeScript   | TYPESCRIPT_ES                         | [eslint](https://megalinter.io/latest/descriptors/typescript_eslint/)           |
+| TypeScript   | ~~TYPESCRIPT_PRETTIER~~               | Not Used                                                                        |
+| TypeScript   | TYPESCRIPT_STANDARD                   | [ts-standard](https://megalinter.io/latest/descriptors/typescript_ts_standard/) |
+| VB.Net       | ~~VBDOTNET_DOTNET_FORMAT~~            | Not Used                                                                        |
+
+## Formats
+
+| Format           | Linter                            | Details                                                                                                 |
+|:-----------------|:----------------------------------|:--------------------------------------------------------------------------------------------------------|
+| CSS              | CSS_STYLELINT                     | [stylelint](https://megalinter.io/latest/descriptors/css_stylelint/)                                    |
+| ENV              | ENV_DOTENV_LINTER                 | [dotenv-linter](https://megalinter.io/latest/descriptors/env_dotenv_linter/)                            |
+| GraphQL          | ~~GRAPHQL_GRAPHQL_SCHEMA_LINTER~~ | Not Used                                                                                                |
+| HTML             | ~~HTML_DJLINT~~                   | Not Used (Refuses to see config file)                                                                   |
+| HTML             | HTML_HTMLHINT                     | [htmlhint](https://megalinter.io/latest/descriptors/html_htmlhint/)                                     |
+| JSON             | JSON_ESLINT_PLUGIN_JSONC          | [eslint-plugin-jsonc](https://megalinter.io/latest/descriptors/json_eslint_plugin_jsonc/)               |
+| JSON             | JSON_JSONLINT                     | [jsonlint](https://megalinter.io/latest/descriptors/json_jsonlint/)                                     |
+| JSON             | JSON_NPM_PACKAGE_JSON_LINT        | [npm-package-json-lint](https://megalinter.io/latest/descriptors/json_npm_package_json_lint/)           |
+| JSON             | ~~JSON_PRETTIER~~                 | Not Used                                                                                                |
+| JSON             | JSON_V8R                          | [v8r](https://megalinter.io/latest/descriptors/json_v8r/)                                               |
+| LaTeX            | ~~LATEX_CHKTEX~~                  | Not Used                                                                                                |
+| Markdown         | MARKDOWN_MARKDOWNLINT             | [markdownlint](https://megalinter.io/latest/descriptors/markdown_markdownlint/)                         |
+| Markdown         | MARKDOWN_MARKDOWN_LINK_CHECK      | [markdown-link-check](https://megalinter.io/latest/descriptors/markdown_markdown_link_check/)           |
+| Markdown         | MARKDOWN_MARKDOWN_TABLE_FORMATTER | [markdown-table-formatter](https://megalinter.io/latest/descriptors/markdown_markdown_table_formatter/) |
+| Markdown         | MARKDOWN_REMARK_LINT              | [remark-lint](https://megalinter.io/latest/descriptors/markdown_remark_lint/)                           |
+| Protocol Buffers | ~~PROTOBUF_PROTOLINT~~            | Not Used                                                                                                |
+| reStructuredText | ~~RST_RSTCHECK~~                  | Not Used                                                                                                |
+| reStructuredText | ~~RST_RSTFMT~~                    | Not Used                                                                                                |
+| reStructuredText | ~~RST_RST_LINT~~                  | Not Used                                                                                                |
+| XML              | XML_XMLLINT                       | [xmllint](https://megalinter.io/latest/descriptors/xml_xmllint/)                                        |
+| YAML             | ~~YAML_PRETTIER~~                 | Not Used                                                                                                |
+| YAML             | YAML_V8R                          | [v8r](https://megalinter.io/latest/descriptors/yaml_v8r/)                                               |
+| YAML             | YAML_YAMLLINT                     | [yamllint](https://megalinter.io/latest/descriptors/yaml_yamllint/)                                     |
+
+## Tooling formats
+
+| Tooling format | Linter                            | Details                                                                                             |
+|:---------------|:----------------------------------|:----------------------------------------------------------------------------------------------------|
+| GitHub Action  | ACTION_ACTIONLINT                 | [actionlint](https://megalinter.io/latest/descriptors/action_actionlint/)                           |
+| Ansible        | ANSIBLE_ANSIBLE_LINT              | [ansible-lint](https://megalinter.io/latest/descriptors/ansible_ansible_lint/)                      |
+| Api            | API_SPECTRAL                      | [spectral](https://megalinter.io/latest/descriptors/api_spectral/)                                  |
+| ARM Templates  | ARM_ARM_TTK                       | [arm-ttk](https://megalinter.io/latest/descriptors/arm_arm_ttk/)                                    |
+| Bicep          | ~~BICEP_BICEP_LINTER~~            | Not Used                                                                                            |
+| CloudFormation | CLOUDFORMATION_CFN_LINT           | [cfn-lint](https://megalinter.io/latest/descriptors/cloudformation_cfn_lint/)                       |
+| Dockerfile     | DOCKERFILE_HADOLINT               | [hadolint](https://megalinter.io/latest/descriptors/dockerfile_hadolint/)                           |
+| EditorConfig   | EDITORCONFIG_EDITORCONFIG_CHECKER | [editorconfig-checker](https://megalinter.io/latest/descriptors/editorconfig_editorconfig_checker/) |
+| Gherkin        | ~~GHERKIN_GHERKIN_LINT~~          | Not Used                                                                                            |
+| Kubernetes     | KUBERNETES_HELM                   | [helm](https://megalinter.io/latest/descriptors/kubernetes_helm/)                                   |
+| Kubernetes     | KUBERNETES_KUBECONFORM            | [kubeconform](https://megalinter.io/latest/descriptors/kubernetes_kubeconform/)                     |
+| Kubernetes     | KUBERNETES_KUBESCAPE              | [kubescape](https://megalinter.io/latest/descriptors/kubernetes_kubescape/)                         |
+| Puppet         | PUPPET_PUPPET_LINT                | [puppet-lint](https://megalinter.io/latest/descriptors/puppet_puppet_lint/)                         |
+| Snakemake      | ~~SNAKEMAKE_LINT~~                | Not Used                                                                                            |
+| Snakemake      | ~~SNAKEMAKE_SNAKEFMT~~            | Not Used                                                                                            |
+| Tekton         | ~~TEKTON_TEKTON_LINT~~            | Not Used                                                                                            |
+| Terraform      | TERRAFORM_TERRAFORM_FMT           | [terraform-fmt](https://megalinter.io/latest/descriptors/terraform_terraform_fmt/)                  |
+| Terraform      | TERRAFORM_TERRAGRUNT              | [terragrunt](https://megalinter.io/latest/descriptors/terraform_terragrunt/)                        |
+| Terraform      | TERRAFORM_TERRASCAN               | [terrascan](https://megalinter.io/latest/descriptors/terraform_terrascan/)                          |
+| Terraform      | TERRAFORM_TFLINT                  | [tflint](https://megalinter.io/latest/descriptors/terraform_tflint/)                                |
+
+## Other
+
+| Other      | Linter                | Details                                                                       |
+|:-----------|:----------------------|:------------------------------------------------------------------------------|
+| Copypaste  | COPYPASTE_JSCPD       | [jscpd](https://megalinter.io/latest/descriptors/copypaste_jscpd/)            |
+| Repository | REPOSITORY_CHECKOV    | [checkov](https://megalinter.io/latest/descriptors/repository_checkov/)       |
+| Repository | REPOSITORY_DEVSKIM    | [devskim](https://megalinter.io/latest/descriptors/repository_devskim/)       |
+| Repository | REPOSITORY_DUSTILOCK  | [dustilock](https://megalinter.io/latest/descriptors/repository_dustilock/)   |
+| Repository | REPOSITORY_GITLEAKS   | [gitleaks](https://megalinter.io/latest/descriptors/repository_gitleaks/)     |
+| Repository | REPOSITORY_GIT_DIFF   | [git_diff](https://megalinter.io/latest/descriptors/repository_git_diff/)     |
+| Repository | REPOSITORY_GRYPE      | [grype](https://megalinter.io/latest/descriptors/repository_grype/)           |
+| Repository | REPOSITORY_KICS       | [kics](https://megalinter.io/latest/descriptors/repository_kics/)             |
+| Repository | REPOSITORY_LS_LINT    | [ls-lint](https://megalinter.io/latest/descriptors/repository_ls_lint/)       |
+| Repository | REPOSITORY_SECRETLINT | [secretlint](https://megalinter.io/latest/descriptors/repository_secretlint/) |
+| Repository | REPOSITORY_SEMGREP    | [semgrep](https://megalinter.io/latest/descriptors/repository_semgrep/)       |
+| Repository | REPOSITORY_SYFT       | [syft](https://megalinter.io/latest/descriptors/repository_syft/)             |
+| Repository | REPOSITORY_TRIVY      | [trivy](https://megalinter.io/latest/descriptors/repository_trivy/)           |
+| Repository | REPOSITORY_TRIVY_SBOM | [trivy-sbom](https://megalinter.io/latest/descriptors/repository_trivy_sbom/) |
+| Repository | REPOSITORY_TRUFFLEHOG | [trufflehog](https://megalinter.io/latest/descriptors/repository_trufflehog/) |
+| Spelling   | ~~SPELL_CSPELL~~      | Not Used                                                                      |
+| Spelling   | SPELL_LYCHEE          | [lychee](https://megalinter.io/latest/descriptors/spell_lychee/)              |
+| Spelling   | SPELL_PROSELINT       | [proselint](https://megalinter.io/latest/descriptors/spell_proselint/)        |
+| Spelling   | SPELL_VALE            | [vale](https://megalinter.io/latest/descriptors/spell_vale/)                  |

data/lib/way_of_working/code_linting/hdi/generators/document_linters.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/string'
+require 'nokogiri'
+require 'open-uri'
+require 'thor'
+require 'way_of_working/paths'
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      module Generators
+        # This class is responsible for generating linter documentation
+        class DocumentLinters < Thor::Group
+          include Thor::Actions # Mixin for action methods provided by Thor
+
+          # Set the source root for the templates
+          source_root ::WayOfWorking::CodeLinting::Hdi.source_root
+
+          # URL of the supported linters
+          SUPPORTED_LINTERS_URL = 'https://megalinter.io/latest/supported-linters/'
+
+          # Method to prepare the list of linters from the supported linters URL
+          def prepare_linter_lists
+            # Initialize an empty hash for linter types
+            @types = {}
+
+            # Iterate over each linter type in the parsed HTML
+            parse_linter_types_html do |type, html_rows|
+              @types[type] = []
+
+              parse_linter_rows(html_rows) do |constant_name, language, name, link|
+                # Create a new linter object and add it to the list
+                @types[type] << SupportedLinter.new(language, constant_name, name, link,
+                                                    enabled_linters)
+              end
+            end
+          end
+
+          # Method to create the linter documentation using a template
+          def create_linters_documentation
+            template 'docs/way_of_working/code-linting/linters.md'
+            copy_file 'docs/way_of_working/code-linting/index.md'
+          end
+
+          private
+
+          def parse_linter_types_html
+            # Parse HTML from the supported linters URL
+            doc = Nokogiri::HTML(URI.parse(SUPPORTED_LINTERS_URL).read)
+
+            doc.css('article h2').each do |h2|
+              type = h2.text.strip
+
+              yield type, h2.next_element.css('tbody tr')
+            end
+          end
+
+          def parse_linter_rows(html_rows)
+            # Iterate over each linter in the current type
+            html_rows.each do |tr|
+              tds = tr.css('td')
+              constant_name = tds[2].css('a')[1].text
+              language = tds[1].text.sub(/\s\([^)]+\)\z/, '')
+              name = tds[2].css('a')[0].text
+              link = tds[2].css('a')[0].attributes['href'].value.sub(/\A\.\./, 'https://megalinter.io/latest')
+
+              yield constant_name, language, name, link
+            end
+          end
+
+          # Load enabled linters from the YAML config file
+          def enabled_linters
+            @enabled_linters ||= YAML.load_file('.mega-linter.yml')['ENABLE_LINTERS']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/generators/exec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'rainbow'
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      module Generators
+        # This generator runs the linter
+        class Exec < Thor::Group
+          argument :path, type: :string, required: false, desc: 'Optional path of the file to lint'
+
+          desc 'This runs the linter on this project'
+
+          def run_first
+            @start_time = Time.now
+
+            say(Rainbow("Limiting linters to #{path}\n").yellow) if path
+          end
+
+          # Run RuboCop
+          def prep_and_run_rubocop
+            say(Rainbow('Running RuboCop...').yellow)
+
+            @rubocop_ok = run_rubocop(ARGV[2..])
+          end
+
+          # Run MegaLinter
+          def prep_and_run_megalinter
+            command = ['npx', 'mega-linter-runner', '--remove-container']
+            # Configure MegaLinter to only lint a specific file or folder, if defined
+            command.prepend("MEGALINTER_FILES_TO_LINT=\"#{path}\"") if path
+            # We only want reports created in the working directory
+            command.prepend('env', "GITHUB_WORKSPACE=\"#{Dir.pwd}\"")
+
+            say(Rainbow("\nRunning MegaLinter...").yellow)
+
+            @megalinter_ok = run_megalinter(command)
+          end
+
+          # We run this last to enable all the linters to run first
+          def run_last
+            say(Rainbow("\nTotal time taken: #{(Time.now - @start_time).to_i} seconds").yellow)
+
+            if !@rubocop_ok || !@megalinter_ok
+              abort(Rainbow("\nLinter failed!").red)
+            else
+              say(Rainbow("\nLinter Succeeded!").green)
+            end
+          end
+
+          private
+
+          def path_directory
+            return path if File.directory?(path)
+
+            File.dirname(path)
+          end
+
+          def run_rubocop(arguments)
+            # We lazy-load RuboCop so that the task doesn't dramatically impact the
+            # load time of our commands.
+            require 'rubocop'
+
+            cli = RuboCop::CLI.new
+            !cli.run(arguments).nonzero?
+          end
+
+          def run_megalinter(arguments)
+            arguments.prepend('time')
+
+            system(*arguments)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/generators/init.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'way_of_working/paths'
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      module Generators
+        # This generator initialises the linter
+        class Init < Thor::Group
+          # include Thor::Actions
+
+          # Intialise the linters
+          invoke InitLinters
+
+          # Document the linters
+          invoke DocumentLinters
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/generators/init_linters.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'way_of_working/paths'
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      module Generators
+        # This generator initialises the linter
+        class InitLinters < Thor::Group
+          include Thor::Actions
+
+          source_root ::WayOfWorking::CodeLinting::Hdi.source_root
+
+          LINTING_BUILD_PHASE =
+            "				2F0882F42AAB152D00DB0B2B /* ShellScript */,\n"
+          LINTING_BUILD_PHASE_DETAILS = <<~CONFIG
+            /* Begin PBXShellScriptBuildPhase section */
+            \t\t2F0882F42AAB152D00DB0B2B /* ShellScript */ = {
+            \t\t\tisa = PBXShellScriptBuildPhase;
+            \t\t\tbuildActionMask = 2147483647;
+            \t\t\tfiles = (
+            \t\t\t);
+            \t\t\tinputFileListPaths = (
+            \t\t\t);
+            \t\t\tinputPaths = (
+            \t\t\t);
+            \t\t\toutputFileListPaths = (
+            \t\t\t);
+            \t\t\toutputPaths = (
+            \t\t\t);
+            \t\t\trunOnlyForDeploymentPostprocessing = 0;
+            \t\t\tshellPath = /bin/sh;
+            \t\t\tshellScript = "if [[ \\"$(uname -m)\\" == arm64 ]]; then\\n    export PATH=\\"/opt/homebrew/bin:$PATH\\"\\nfi\\n\\nif which swiftlint > /dev/null; then\\n  swiftlint\\nelse\\n  echo \\"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\\"\\nfi\\n";
+            \t\t};
+            /* End PBXShellScriptBuildPhase section */
+
+          CONFIG
+
+          # TODO: copy_rubocop_github_workflow_action
+
+          def copy_github_linters_rubocop_config_file
+            copy_file '.github/linters/rubocop_defaults.yml'
+          end
+
+          def copy_github_linters_markdown_link_check_config_file
+            copy_file '.github/linters/.markdown-link-check.json'
+          end
+
+          def copy_megalinter_github_workflow_action
+            copy_file '.github/workflows/mega-linter.yml'
+          end
+
+          def copy_megalinter_dot_file
+            copy_file '.mega-linter.yml'
+          end
+
+          def create_gitignore_if_missing
+            create_file_if_missing '.gitignore'
+          end
+
+          def gitignore_reports_folder
+            append_to_file '.gitignore', "megalinter-reports/\n"
+          end
+
+          def gitignore_rubocop_cached_file
+            append_to_file '.gitignore', ".rubocop-https---*\n"
+          end
+
+          def copy_rubocop_options_file
+            copy_file '.rubocop'
+          end
+
+          def inject_swiftlint_into_xcode_project_build_process
+            return unless xcode_project_file && File.exist?(xcode_project_file)
+
+            inject_into_file xcode_project_file,
+                             LINTING_BUILD_PHASE,
+                             after: "buildPhases = (\n"
+
+            inject_into_file xcode_project_file,
+                             LINTING_BUILD_PHASE_DETAILS,
+                             after: "/* End PBXResourcesBuildPhase section */\n\n"
+          end
+
+          private
+
+          def xcode_project_file
+            Dir.glob(File.join(destination_root, '*.xcodeproj/project.pbxproj')).first
+          end
+
+          def create_file_if_missing(path)
+            path = File.join(destination_root, path)
+            return if behavior == :revoke || File.exist?(path)
+
+            File.open(path, 'w', &:write)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/github_audit_rule.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'way_of_working/audit/github/rules/base'
+
+module WayOfWorking
+  module CodeLinting
+    # The namespace for this plugin
+    module Hdi
+      # This rule checks for the MegaLinter workflow action and README badge.
+      class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
+        source_root WayOfWorking::CodeLinting::Hdi.source_root
+
+        def validate
+          workflows = @client.workflows(@repo_name).workflows
+          @errors << 'No HDI MegaLinter GitHub Action' unless workflows.map(&:name).include?('MegaLinter')
+
+          @errors << 'No HDI MegaLinter README Badge' unless megalinter_badge?
+
+          validate_repo_file_contains_source_file(
+            '.github/linters/rubocop_defaults.yml',
+            '.mega-linter.yml',
+            '.rubocop'
+          )
+        end
+
+        private
+
+        def repo_file_contains_source_file?(path)
+          repo_file_contains?(path, File.read(self.class.source_root.join(path)))
+        end
+
+        def repo_file_contains?(path, text)
+          remote_content = repo_file_contents(path)
+          return false if remote_content.nil?
+
+          remote_content.include?(text)
+        end
+
+        def validate_repo_file_contains_source_file(*paths)
+          paths.each do |path|
+            if repo_file_contents(path).nil?
+              @errors << "#{path} missing"
+              next
+            end
+
+            @errors << "#{path} does not match the source template" unless repo_file_contains_source_file?(path)
+          end
+        end
+
+        def megalinter_badge?
+          readme_content.include?("[![MegaLinter](https://github.com/#{@repo_name}/workflows/MegaLinter/badge.svg")
+        end
+      end
+
+      ::WayOfWorking::Audit::Github::Rules::Registry.register(
+        GithubAuditRule, 'HDI MegaLinter GitHub Action and README badge'
+      )
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/paths.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module WayOfWorking
+  module CodeLinting
+    # Mixin that provides a couple of pathname convenience methods
+    module Hdi
+      class << self
+        def root
+          Pathname.new(File.expand_path('../../../..', __dir__))
+        end
+
+        def source_root
+          root.join('lib', 'way_of_working', 'code_linting', 'hdi', 'templates')
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/plugin.rb

@@ -0,0 +1 @@
+require 'way_of_working/code_linting/hdi'

data/lib/way_of_working/code_linting/hdi/supported_linter.rb

@@ -0,0 +1,91 @@
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      # Struct to hold linter data
+      class SupportedLinter
+        # Reasons why certain linters are not used
+        NOT_USED_REASON = {
+          'CSS_SCSS_LINT' => 'scss-lint recommends using stylelint',
+          'HTML_DJLINT' => 'Refuses to see config file',
+          'RUBY_RUBOCOP' => 'RuboCop is used directly'
+        }.freeze
+
+        # Acronyms for languages
+        TLA_LANGUAGES = %w[
+          CSS
+          ENV
+          HTML
+          JSON
+          JSX
+          PHP
+          SQL
+          TSX
+          XML
+          YAML
+        ].freeze
+
+        # Mapping for languages
+        LANGUAGE_MAPPINGS = {
+          'Action' => 'GitHub Action',
+          'Arm' => 'ARM Templates',
+          'Cloudformation' => 'CloudFormation',
+          'Coffee' => 'CoffeeScript',
+          'Editorconfig' => 'EditorConfig',
+          'Graphql' => 'GraphQL',
+          'Javascript' => 'JavaScript',
+          'Latex' => 'LaTeX',
+          'Protobuf' => 'Protocol Buffers',
+          'Rst' => 'reStructuredText',
+          'Spell' => 'Spelling',
+          'Typescript' => 'TypeScript',
+          'Visual Basic .Net' => 'VB.Net'
+        }.freeze
+
+        attr_accessor :name, :link, :enabled_linters, :sorter
+
+        def initialize(language, constant_name, name, link, enabled_linters)
+          @original_language = language
+          @original_constant_name = constant_name
+          @name = name
+          @link = link
+          @enabled_linters = enabled_linters
+
+          # Array used for sorting
+          @sorter = [@original_language, @original_constant_name]
+        end
+
+        def language
+          language = @original_language
+
+          # Titleize language unless it is an acronym
+          language = language.titleize unless TLA_LANGUAGES.include?(language)
+
+          # Use mapped language name if available
+          language = LANGUAGE_MAPPINGS[language] if LANGUAGE_MAPPINGS.key?(language)
+
+          language
+        end
+
+        def constant_name
+          return @original_constant_name if enabled_linters.include?(@original_constant_name)
+
+          # Strike-through the constant name if the linter is not used
+          "~~#{@original_constant_name}~~"
+        end
+
+        def details
+          return "[#{name}](#{link})" if enabled_linters.include?(@original_constant_name)
+
+          details = 'Not Used'
+
+          # Add reason if available
+          if NOT_USED_REASON.key?(@original_constant_name)
+            details = "#{details} (#{NOT_USED_REASON[@original_constant_name]})"
+          end
+
+          details
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi/templates/.github/linters/.markdown-link-check.json

@@ -0,0 +1,13 @@
+{
+    "ignorePatterns": [
+        {
+            "pattern": "^0005-example.md"
+        },
+        {
+            "pattern": "^adr-template.md"
+        }
+    ],
+    "retryOn429": true,
+    "retryCount": 5,
+    "aliveStatusCodes": [ 200, 203 ]
+}