way_of_working-code_linting-hdi 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63283e1c6860b1a7b4d02fce81b3ed85baaaca417ab068f2e52a92431e228729
-  data.tar.gz: 41c58a76977acbf970fccd0e812c3edda789e3987d72b0e4e74903aa8f98a8ad
+  metadata.gz: b0b5505c490be707c1d82d6aa49db94edfee7b45d6ff9c0e1ddd1342d00ea1e4
+  data.tar.gz: 3fb85226ed2f3e3ea8d2131634093a0bd36b705e7a6c5a394937e77a413a82cc
 SHA512:
-  metadata.gz: f004091c09472b59b64833cffb2398c5f9c6f560043442a5bfeb85e05fa7043f1f478d8ac2dcb19235cf47211e05b40c8b952e031dcf7b7c726651ae238949fd
-  data.tar.gz: 6a15f2783ac0080362bdf2026d13968115ef39b58a6f88f13785c3be556c0d49876557d27041dbfe297194d9d064d786e4cb8a4f7df8b8360311f63412c7a4a3
+  metadata.gz: b1be504c13400869436332a6ef4a7f4e98ee64c8df5b3eed005beb9fa68caf34fe7bcb533491ce308c7ee65c55a0c94fa6d65273591ba093e064bc7d55162434
+  data.tar.gz: 502f0e10e48072c2df0b5c075a4e4dd1bff46c96a5f6d12bce8aec44da4c28362602a3faa73035c94a31951a03c602e3d3b601abae48d8970c0cb2198b21e2ed

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable-file MD024 -->
 # Changelog
 
 All notable changes to this project will be documented in this file.
@@ -7,6 +8,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.1] - 2025-11-28
+
+### Changed
+
+- Updated GitHub rule signatures
+- Removed Zeitwerk ignore to make it happier
+
+## [1.1.0] - 2025-10-15
+
+### Added
+
+- Switched from Standard to ESLint (with Standard rules) to enable us to add Cypress and Jasmine globals
+- Added CODEOWNERS protection of the linting standards files
+
+### Changed
+
+- Switched to MegaLinter v9
+- Updated the linting GitHub workflow in line with upstream changes
+- Rewritten the documentation to be easier to read for both humans and LLMs.
+
 ## [1.0.0] - 2025-01-27
 
 ### Added
@@ -16,5 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added MegaLinter for linting common file formats with generator command and rake task
 - Added a GitHub audit rule to check that linting is used and configured correctly
 
-[unreleased]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/compare/v1.1.1...HEAD
+[1.1.1]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/compare/v1.0.0...v1.1.1
+[1.1.0]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/releases/tag/v1.0.0

data/README.md

@@ -11,18 +11,16 @@ Code linters like MegaLinter benefit developers and teams because they help impr
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add way_of_working-code_linting-hdi
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install way_of_working-code_linting-hdi
 ```
 
 ## Usage

data/code_safety.yml

@@ -4,34 +4,38 @@ file safety:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  ".github/CODEOWNERS":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   ".github/linters/.markdown-link-check.json":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   ".github/linters/rubocop_defaults.yml":
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
   ".github/workflows/inclusive-language.yml":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   ".github/workflows/main.yml":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   ".github/workflows/mega-linter.yml":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   ".gitignore":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   ".mega-linter.yml":
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   ".rubocop":
     comments:
     reviewed_by: shilpigoeldev
@@ -39,23 +43,23 @@ file safety:
   CHANGELOG.md:
     comments:
     reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    safe_revision: 021a64c32f5dc6541497d661b683a36bc793c091
   Gemfile:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   Gemfile.lock:
     comments:
     reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    safe_revision: 021a64c32f5dc6541497d661b683a36bc793c091
   LICENSE.txt:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
   README.md:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 2af6973c231a711ae512dc2d3bd3280b11382d6c
   Rakefile:
     comments:
     reviewed_by: shilpigoeldev
@@ -70,20 +74,24 @@ file safety:
     safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
   docs/way_of_working/code-linting/index.md:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   docs/way_of_working/code-linting/linters.md:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   lib/way_of_working/code_linting/hdi.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
+  lib/way_of_working/code_linting/hdi/generators/concerns/github_metadata.rb:
     comments:
     reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   lib/way_of_working/code_linting/hdi/generators/document_linters.rb:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   lib/way_of_working/code_linting/hdi/generators/exec.rb:
     comments:
     reviewed_by: shilpigoeldev
@@ -95,7 +103,7 @@ file safety:
   lib/way_of_working/code_linting/hdi/generators/init_linters.rb:
     comments:
     reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    safe_revision: 8452b01ebb948e84ea0c8389da0187571ca48dbb
   lib/way_of_working/code_linting/hdi/github_audit_rule.rb:
     comments:
     reviewed_by: shilpigoeldev
@@ -106,36 +114,40 @@ file safety:
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
   lib/way_of_working/code_linting/hdi/plugin.rb:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   lib/way_of_working/code_linting/hdi/supported_linter.rb:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.eslintrc.js:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8452b01ebb948e84ea0c8389da0187571ca48dbb
   lib/way_of_working/code_linting/hdi/templates/.github/linters/.markdown-link-check.json:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 2af6973c231a711ae512dc2d3bd3280b11382d6c
   lib/way_of_working/code_linting/hdi/templates/.github/linters/rubocop_defaults.yml:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
   lib/way_of_working/code_linting/hdi/templates/.github/workflows/mega-linter.yml:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   lib/way_of_working/code_linting/hdi/templates/.mega-linter.yml:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c
   lib/way_of_working/code_linting/hdi/templates/.rubocop:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
-  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/index.md.tt:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/linters.md.tt:
     comments:
     reviewed_by: shilpigoeldev
@@ -143,7 +155,7 @@ file safety:
   lib/way_of_working/code_linting/hdi/version.rb:
     comments:
     reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    safe_revision: 021a64c32f5dc6541497d661b683a36bc793c091
   test/resources/XcodeApp.xcodeproj/project.pbxproj:
     comments:
     reviewed_by: shilpigoeldev
@@ -154,16 +166,16 @@ file safety:
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
   test/way_of_working/audit_github_stub_classes.rb:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 9c246b038991ac78d79effd5f960e90a6a3e4547
   test/way_of_working/code_linting/hdi/generators/document_linters_test.rb:
     comments:
     reviewed_by: shilpigoeldev
     safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
   test/way_of_working/code_linting/hdi/generators/exec_test.rb:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 2af6973c231a711ae512dc2d3bd3280b11382d6c
   test/way_of_working/code_linting/hdi/generators/init_linters_test.rb:
     comments:
     reviewed_by: shilpigoeldev
@@ -182,5 +194,5 @@ file safety:
     safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
   way_of_working-code_linting-hdi.gemspec:
     comments:
-    reviewed_by: shilpigoeldev
-    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+    reviewed_by: timgentry
+    safe_revision: 82687366222b885cbc41449f5bbd30fe9440cd4c

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

@@ -1,39 +1,74 @@
 ---
 has_children: true
 layout: page
+status: REQUIRED
+enforcement: manual
 ---
 
 # Code Linting
 
-We use [MegaLinter](https://megalinter.io/) for the majority of our code lining, currently with separate Ruby testing with RuboCop.
+## Overview
 
-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.
+We use [MegaLinter](https://megalinter.io/) for most of our linting, but we use [RuboCop](https://rubocop.org) separately for Ruby to support Minitest and Rails cops.
 
-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.
+Linters help by:
+- Catching syntax errors, undefined variables, and unused code early
+- Ensuring consistent code style across teams and projects
+- Providing automated quality improvements and best practices
+- Saving time in code review and debugging
 
-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.
+## Setup
 
-{: .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.
+Add linting to your project:
 
-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.
+```bash
+way_of_working init code_linting
+```
 
-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.
+This copies organisational coding standards and GitHub Actions workflows to your project.
 
-{: .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).
+{: .note }
+For Xcode projects, a SwiftLint build phase is automatically added to the project config.
 
 ## Usage
 
-To add [MegaLinter](https://megalinter.io/) and [RuboCop](https://rubocop.org) to your project, run the following at the command line:
+Run linting locally:
+
+```bash
+way_of_working exec code_linting
+```
+
+executes both MegaLinter and RuboCop against your code.
+
+## Configuration
+
+Language-specific configs are in the project root or `.github/linters/`. See [linters.md](linters.md) for the complete list.
 
-    way_of_working init code_linting
+To customise for your project, talk to a member of [code-standards-team](https://github.com/orgs/HealthDataInsight/teams/code-standards-team) and modify the config files as needed, keeping changes minimal and well documented.
+Pull Request changing linting configs require review by a member of code-standards-team.
 
-to run MegaLinter in your project, run:
+## Handling Exceptions
 
-    way_of_working exec code_linting
+On the rare occasions when linters flag false positives, turn off rules with comments giving your justification:
+
+```python
+# pylint: disable=line-too-long - URL cannot be broken
+LONG_URL = "https://example.com/very/long/path/..."
+```
+
+## Documentation
+
+Generate project documentation:
+
+```bash
+way_of_working exec document
+```
+
+{: .important }
+If you disagree with any linter or coding style, please fork the Way of Working code linting [repository](https://github.com/HealthDataInsight/way_of_working-code_linting-hdi) and create a pull request with your proposed changes. The current standards are a starting point intended to evolve with team consensus.
 
-to document your use of MegaLinter in your project, run:
+## Resources
 
-    way_of_working exec document
+- [MegaLinter documentation](https://megalinter.io/)
+- [RuboCop documentation](https://rubocop.org)
+- [Active linters list](linters.md)