way_of_working-code_linting-hdi 1.0.0

data/lib/way_of_working/code_linting/hdi/templates/.github/linters/rubocop_defaults.yml

@@ -0,0 +1,55 @@
+---
+require:
+  - ndr_dev_support
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 3.1
+
+# Ignore rules related to templated files
+Layout/EmptyLines:
+  Exclude:
+    - "config/**/*.rb"
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - "config/**/*.rb"
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - "app/helpers/application_helper.rb"
+    - "config/**/*.rb"
+
+Style/GlobalStdStream:
+  Exclude:
+    - "config/environments/production.rb"
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/RedundantConstantBase:
+  Exclude:
+    - "config/environments/production.rb"
+
+Style/RedundantFetchBlock:
+  Exclude:
+    - "config/puma.rb"
+
+Style/StringLiterals:
+  Exclude:
+    - "config.ru"
+    - "config/**/*.rb"
+    - "Rakefile"
+
+Style/SymbolArray:
+  Exclude:
+    - "config/initializers/filter_parameter_logging.rb"

data/lib/way_of_working/code_linting/hdi/templates/.github/workflows/mega-linter.yml

@@ -0,0 +1,88 @@
+---
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+name: MegaLinter
+
+on:  # yamllint disable-line rule:truthy
+  # Trigger mega-linter at key points in the PR process
+  pull_request:
+    types:
+      - opened
+      - ready_for_review
+      - review_requested
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+env:  # Comment env block if you do not want to apply fixes
+  # Apply linter fixes configuration
+  APPLY_FIXES: none  # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
+  APPLY_FIXES_EVENT: pull_request  # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
+  APPLY_FIXES_MODE: commit  # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+      # MegaLinter
+      - name: MegaLinter
+        id: ml
+        # You can override MegaLinter flavor used to have faster performances
+        # More info at https://megalinter.io/flavors/
+        uses: oxsecurity/megalinter@v8
+        env:
+          # All available variables are described in documentation
+          # https://megalinter.io/configuration/
+          VALIDATE_ALL_CODEBASE: true  # Set ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} to validate only diff with main branch
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
+
+      # # Upload MegaLinter artifacts
+      # - name: Archive production artifacts
+      #   if: ${{ success() }} || ${{ failure() }}
+      #   uses: actions/upload-artifact@v3
+      #   with:
+      #     name: MegaLinter reports
+      #     path: |
+      #       megalinter-reports
+      #       mega-linter.log
+
+      # # Create pull request if applicable (for now works only on PR from same repository, not from forks)
+      # - name: Create Pull Request with applied fixes
+      #   id: cpr
+      #   if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+      #   uses: peter-evans/create-pull-request@v4
+      #   with:
+      #     token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+      #     commit-message: "[MegaLinter] Apply linters automatic fixes"
+      #     title: "[MegaLinter] Apply linters automatic fixes"
+      #     labels: bot
+      # - name: Create PR output
+      #   if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+      #   run: |
+      #     echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+      #     echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      # # Push new commit if applicable (for now works only on PR from same repository, not from forks)
+      # - name: Prepare commit
+      #   if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+      #   run: sudo chown -Rc $UID .git/
+      # - name: Commit and push applied linter fixes
+      #   if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+      #   uses: stefanzweifel/git-auto-commit-action@v4
+      #   with:
+      #     branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
+      #     commit_message: "[MegaLinter] Apply linters fixes"

data/lib/way_of_working/code_linting/hdi/templates/.mega-linter.yml

@@ -0,0 +1,145 @@
+---
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/
+# and in linters documentation
+
+APPLY_FIXES: none  # all, none, or list of linter keys
+ENABLE_LINTERS:  # All other linters will be disabled by default
+  ### Languages
+  - BASH_EXEC  # in Super-Linter
+  - BASH_SHELLCHECK  # in Super-Linter
+  - BASH_SHFMT  # in Super-Linter
+  - C_CLANG_FORMAT
+  - C_CPPLINT
+  # - CLOJURE_CLJ_KONDO  # in Super-Linter
+  # - CLOJURE_CLJSTYLE
+  - COFFEE_COFFEELINT  # in Super-Linter
+  - CPP_CLANG_FORMAT
+  - CPP_CPPLINT  # in Super-Linter
+  - CSHARP_CSHARPIER
+  - CSHARP_DOTNET_FORMAT  # in Super-Linter
+  - CSHARP_ROSLYNATOR
+  - DART_DARTANALYZER  # in Super-Linter
+  - GO_GOLANGCI_LINT  # in Super-Linter
+  - GO_REVIVE
+  # - GROOVY_NPM_GROOVY_LINT  # in Super-Linter
+  - JAVA_CHECKSTYLE  # in Super-Linter
+  - JAVA_PMD
+  - JAVASCRIPT_ES  # in Super-Linter
+  # - JAVASCRIPT_PRETTIER
+  - JAVASCRIPT_STANDARD  # in Super-Linter
+  - JSX_ESLINT
+  - KOTLIN_DETEKT
+  - KOTLIN_KTLINT  # in Super-Linter
+  # - LUA_LUACHECK  # in Super-Linter
+  # - LUA_SELENE
+  # - LUA_STYLUA
+  - MAKEFILE_CHECKMAKE
+  # - PERL_PERLCRITIC  # in Super-Linter
+  # - PHP_BUILTIN
+  # - PHP_PHPCS  # in Super-Linter
+  # - PHP_PHPCSFIXER
+  # - PHP_PHPLINT  # in Super-Linter
+  # - PHP_PHPSTAN  # in Super-Linter
+  # - PHP_PSALM  # in Super-Linter
+  # - POWERSHELL_POWERSHELL
+  # - POWERSHELL_POWERSHELL_FORMATTER
+  - PYTHON_BANDIT
+  - PYTHON_BLACK  # in Super-Linter
+  - PYTHON_FLAKE8  # in Super-Linter
+  - PYTHON_ISORT  # in Super-Linter
+  - PYTHON_MYPY
+  - PYTHON_PYLINT  # in Super-Linter
+  - PYTHON_PYRIGHT
+  - PYTHON_RUFF
+  - R_LINTR  # in Super-Linter
+  # - RAKU_RAKU  # in Super-Linter
+  # - RUBY_RUBOCOP  # in Super-Linter
+  - RUST_CLIPPY  # in Super-Linter
+  # - SALESFORCE_LIGHTNING_FLOW_SCANNER
+  # - SALESFORCE_SFDX_SCANNER_APEX
+  # - SALESFORCE_SFDX_SCANNER_AURA
+  # - SALESFORCE_SFDX_SCANNER_LWC
+  - SCALA_SCALAFIX
+  - SQL_SQLFLUFF  # in Super-Linter
+  - SQL_TSQLLINT
+  - SWIFT_SWIFTLINT
+  - TSX_ESLINT
+  - TYPESCRIPT_ES  # in Super-Linter
+  # - TYPESCRIPT_PRETTIER
+  - TYPESCRIPT_STANDARD  # in Super-Linter
+  # - VBDOTNET_DOTNET_FORMAT
+
+  ### Formats
+  - CSS_STYLELINT  # in Super-Linter
+  - ENV_DOTENV_LINTER  # in Super-Linter
+  # - GRAPHQL_GRAPHQL_SCHEMA_LINTER
+  # - HTML_DJLINT # Refuses to see config file
+  - HTML_HTMLHINT  # in Super-Linter
+  - JSON_ESLINT_PLUGIN_JSONC  # in Super-Linter
+  - JSON_JSONLINT
+  - JSON_NPM_PACKAGE_JSON_LINT
+  # - JSON_PRETTIER
+  - JSON_V8R
+  # - LATEX_CHKTEX  # in Super-Linter
+  - MARKDOWN_MARKDOWNLINT  # in Super-Linter
+  - MARKDOWN_MARKDOWN_LINK_CHECK
+  - MARKDOWN_MARKDOWN_TABLE_FORMATTER
+  - MARKDOWN_REMARK_LINT
+  # - PROTOBUF_PROTOLINT  # in Super-Linter
+  # - RST_RSTCHECK
+  # - RST_RSTFMT
+  # - RST_RST_LINT
+  - XML_XMLLINT  # in Super-Linter
+  # - YAML_PRETTIER
+  - YAML_V8R
+  - YAML_YAMLLINT  # in Super-Linter
+
+  ### Tooling
+  - ACTION_ACTIONLINT  # in Super-Linter
+  - ANSIBLE_ANSIBLE_LINT  # in Super-Linter
+  - API_SPECTRAL
+  - ARM_ARM_TTK  # in Super-Linter
+  # - BICEP_BICEP_LINTER
+  - CLOUDFORMATION_CFN_LINT  # in Super-Linter
+  - DOCKERFILE_HADOLINT  # in Super-Linter
+  - EDITORCONFIG_EDITORCONFIG_CHECKER  # in Super-Linter
+  # - GHERKIN_GHERKIN_LINT  # in Super-Linter
+  - KUBERNETES_HELM
+  - KUBERNETES_KUBECONFORM
+  - KUBERNETES_KUBESCAPE
+  - PUPPET_PUPPET_LINT
+  # - SNAKEMAKE_LINT  # in Super-Linter
+  # - SNAKEMAKE_SNAKEFMT  # in Super-Linter
+  # - TEKTON_TEKTON_LINT  # in Super-Linter
+  - TERRAFORM_TERRAFORM_FMT  # in Super-Linter
+  - TERRAFORM_TERRAGRUNT  # in Super-Linter
+  - TERRAFORM_TERRASCAN  # in Super-Linter
+  - TERRAFORM_TFLINT  # in Super-Linter
+
+  ### Code quality checkers
+  - COPYPASTE_JSCPD  # in Super-Linter
+  - REPOSITORY_CHECKOV
+  - REPOSITORY_DEVSKIM
+  - REPOSITORY_DUSTILOCK
+  - REPOSITORY_GIT_DIFF
+  - REPOSITORY_GITLEAKS  # in Super-Linter
+  - REPOSITORY_GRYPE
+  - REPOSITORY_KICS
+  - REPOSITORY_LS_LINT
+  - REPOSITORY_SECRETLINT
+  - REPOSITORY_SEMGREP
+  - REPOSITORY_SYFT
+  - REPOSITORY_TRIVY
+  - REPOSITORY_TRIVY_SBOM
+  - REPOSITORY_TRUFFLEHOG
+  # - SPELL_CSPELL
+  - SPELL_LYCHEE
+  - SPELL_PROSELINT
+  - SPELL_VALE
+
+SHOW_ELAPSED_TIME: false
+FILEIO_REPORTER: false
+FAIL_IF_MISSING_LINTER_IN_FLAVOR: true
+# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect
+# errors but not block CI to pass

data/lib/way_of_working/code_linting/hdi/templates/.rubocop

@@ -0,0 +1 @@
+--config .github/linters/rubocop_defaults.yml

data/lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/index.md

@@ -0,0 +1,39 @@
+---
+has_children: true
+layout: page
+---
+
+# Code Linting
+
+We use [MegaLinter](https://megalinter.io/) for the majority of our code lining, currently with separate Ruby testing with RuboCop.
+
+Code linters like MegaLinter benefit developers and teams because they help improve code quality, reduce errors and inconsistencies, and streamline development. Linters analyze source code for common issues, such as syntax errors, undefined variables, and unused code, and provide suggestions and feedback for improvement.
+
+Using a linter like MegaLinter, developers can catch and fix errors early in the development process, saving time and effort in the long run.
+The linter also provides consistency in the codebase, helping to prevent errors caused by different team members using different styles or approaches, which can be especially valuable for large projects with many contributors or where you want staff to be able to switch between projects more efficiently.
+
+MegaLinter is a particularly powerful linter because it supports multiple programming languages, making it a one-stop shop for developers working on projects with various languages.
+
+{: .note }
+We have chosen not to use the version of [RuboCop](https://rubocop.org) packaged in MegaLinter because it can't support our use of Minitest and Rails "cops". But by using our CLI command to run linting, as documented below, both RuboCop and MegaLinter will be executed against your code.
+
+When you add the Way of Working linter to your project, it will copy our per-language organisational code styles (where they differ from defaults) into `.github/linters` and will copy the GitHub Actions workflow files into `.github/workflow`, so that linting automatically runs when you commit to GitHub.
+
+If you add the Way of Working linter to your Xcode project, it will automatically add a Swiftlint build phase to the project config file.
+
+{: .important }
+If you disagree with any of the linters or linting styles that they apply, please fork the repository and create a pull request with your desired changes. The current coding standards are only intended as a starting point. A Full list of the linters we are currently using can be found [here](linters.md).
+
+## Usage
+
+To add [MegaLinter](https://megalinter.io/) and [RuboCop](https://rubocop.org) to your project, run the following at the command line:
+
+    way_of_working init code_linting
+
+to run MegaLinter in your project, run:
+
+    way_of_working exec code_linting
+
+to document your use of MegaLinter in your project, run:
+
+    way_of_working exec document

data/lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/linters.md.tt

@@ -0,0 +1,24 @@
+---
+layout: page
+nav_order: 1
+parent: Code Linting
+---
+
+# Linters
+
+The following tables detail the linters that we are currently using:
+<% @types.each do |type, linters| -%>
+
+## <%= type %>
+
+<%
+max_language_length = linters.map(&:language).map(&:length).max
+max_constant_name_length = linters.map(&:constant_name).map(&:length).max
+max_details_length = linters.map(&:details).map(&:length).max
+-%>
+| <%= type.singularize.ljust(max_language_length) %> | <%= 'Linter'.ljust(max_constant_name_length) %> | <%= 'Details'.ljust(max_details_length) %> |
+|<%= ':'.ljust(max_language_length + 2, '-') %>|<%= ':'.ljust(max_constant_name_length + 2, '-') %>|<%= ':'.ljust(max_details_length + 2, '-') %>|
+<% linters.sort_by(&:sorter).each do |linter| -%>
+| <%= linter.language.ljust(max_language_length) %> | <%= linter.constant_name.ljust(max_constant_name_length) %> | <%= linter.details.ljust(max_details_length) %> |
+<% end -%>
+<% end -%>

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/way_of_working/code_linting/hdi.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'way_of_working'
+require_relative 'hdi/paths'
+require 'zeitwerk'
+
+# If way_of_working-audit-github is used we can add a rule
+begin
+  require 'way_of_working/audit/github/rules/registry'
+  require_relative 'hdi/github_audit_rule'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::CodeLinting)
+loader.ignore("#{__dir__}/hdi/plugin.rb")
+loader.setup
+
+module WayOfWorking
+  module CodeLinting
+    module Hdi
+      class Error < StandardError; end
+    end
+  end
+
+  module SubCommands
+    # This reopens the "way_of_working exec" sub command
+    class Exec
+      register(CodeLinting::Hdi::Generators::Exec, 'code_linting', 'code_linting',
+               <<~LONGDESC)
+                 Description:
+                     This runs code linting on this project
+
+                 Example:
+                     way_of_working exec code_linting
+               LONGDESC
+    end
+
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(CodeLinting::Hdi::Generators::Init, 'code_linting', 'code_linting',
+               <<~LONGDESC)
+                 Description:
+                     Installs code linting config files into the project
+
+                 Example:
+                     way_of_working init code_linting
+
+                     This will create:
+                         .github/workflows/mega-linter.yml
+                         .mega-linter.yml
+               LONGDESC
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: way_of_working-code_linting-hdi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gentry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: way_of_working
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+description:
+email:
+- 52189+timgentry@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".alexrc"
+- ".mega-linter.yml"
+- ".rubocop"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- code_safety.yml
+- docs/way_of_working/code-linting/index.md
+- docs/way_of_working/code-linting/linters.md
+- lib/way_of_working/code_linting/hdi.rb
+- lib/way_of_working/code_linting/hdi/generators/document_linters.rb
+- lib/way_of_working/code_linting/hdi/generators/exec.rb
+- lib/way_of_working/code_linting/hdi/generators/init.rb
+- lib/way_of_working/code_linting/hdi/generators/init_linters.rb
+- lib/way_of_working/code_linting/hdi/github_audit_rule.rb
+- lib/way_of_working/code_linting/hdi/paths.rb
+- lib/way_of_working/code_linting/hdi/plugin.rb
+- lib/way_of_working/code_linting/hdi/supported_linter.rb
+- lib/way_of_working/code_linting/hdi/templates/.github/linters/.markdown-link-check.json
+- lib/way_of_working/code_linting/hdi/templates/.github/linters/rubocop_defaults.yml
+- lib/way_of_working/code_linting/hdi/templates/.github/workflows/mega-linter.yml
+- lib/way_of_working/code_linting/hdi/templates/.mega-linter.yml
+- lib/way_of_working/code_linting/hdi/templates/.rubocop
+- lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/index.md
+- lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/linters.md.tt
+- lib/way_of_working/code_linting/hdi/version.rb
+homepage: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi
+  source_code_uri: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi
+  changelog_uri: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Way of Working plugin for HDI code linting using MegaLinter and Rubocop
+test_files: []