feat: automatically add local rubocop requires to config_files #2336

marschattha · 2025-08-20T23:24:34Z

No description provided.

github-actions · 2025-08-20T23:24:44Z

No issue mentions found. Please mention an issue in the pull request description.

Use GitHub automation to close the issue when a PR is merged

Copilot

Pull Request Overview

This PR automatically adds local RuboCop custom cop files to the config_files section in the Qlty configuration. The feature detects local custom cop file paths from RuboCop configuration files and includes them in the generated Qlty configuration.

Key Changes

Added RuboCop configuration parsing to extract custom cop file paths from YAML configs
Extended the plugin activation structure to support config_files field
Modified the TOML renderer to output the config_files section for plugins

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`qlty-cli/src/initializer/scanner/rubocop_config.rs`	New module implementing custom cop file extraction from RuboCop YAML configurations
`qlty-cli/src/initializer/scanner.rs`	Added module declaration for the new rubocop_config module
`qlty-cli/src/initializer/renderer.rs`	Extended PluginActivation struct and TOML rendering to support config_files field
`qlty-cli/src/initializer/initializer.rs`	Added RuboCop-specific logic to detect and include custom cop files during initialization
Test files	Added integration test case demonstrating the feature with sample RuboCop configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

qlty-cli/src/initializer/initializer.rs

qlty-cli/src/initializer/scanner/rubocop_config.rs

qltysh · 2025-08-20T23:27:22Z

Diff Coverage for macos-15: The code coverage on the diff in this pull request is 96.4%.

Total Coverage for macos-15: This PR will increase coverage by 0.04%.

File Coverage Changes

Path	File Coverage Δ	Indirect
qlty-cli/src/initializer/custom_enabler.rs	100.0
qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs	95.6
qlty-cli/src/initializer/initializer.rs	4.6
qlty-cli/src/initializer/renderer.rs	0.1
qlty-coverage/src/ci/github.rs	-0.3	√

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

qltysh · 2025-08-20T23:27:31Z

Diff Coverage for ubuntu-latest: The code coverage on the diff in this pull request is 96.4%.

Total Coverage for ubuntu-latest: This PR will increase coverage by 0.04%.

File Coverage Changes

Path	File Coverage Δ	Indirect
qlty-check/src/executor.rs	16.6	√
qlty-check/src/executor/invocation_script.rs	2.1	√
qlty-check/src/executor/staging_area.rs	6.0	√
qlty-check/src/parser/clippy.rs	0.8	√
qlty-check/src/planner.rs	8.6	√
qlty-check/src/planner/config.rs	-0.3	√
qlty-check/src/planner/config_files.rs	9.1	√
qlty-check/src/planner/plan.rs	4.8	√
qlty-check/src/settings.rs	7.3	√
qlty-cli/src/commands/check.rs	15.0	√
qlty-cli/src/commands/coverage/publish.rs	11.2	√
qlty-cli/src/commands/coverage/utils.rs	8.0	√
qlty-cli/src/initializer/custom_enabler.rs	100.0
qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs	95.6
qlty-cli/src/initializer/initializer.rs	10.4
qlty-cli/src/initializer/renderer.rs	0.1
qlty-config/src/config/builder.rs	3.6	√
qlty-config/src/migration.rs	-0.5	√
qlty-config/src/migration/checks.rs	-0.1	√
qlty-coverage/src/ci/buildkite.rs	0.2	√
qlty-coverage/src/ci/github.rs	-0.3	√
qlty-coverage/src/git.rs	28.2	√
qlty-coverage/src/publish/planner.rs	2.3	√
qlty-coverage/src/transformer.rs	-1.7	√

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

qltysh · 2025-08-20T23:27:59Z

1 new issue

Tool	Category	Rule	Count
qlty	Structure	Deeply nested control flow (level = 5)	1

qlty-cli/src/initializer/scanner/rubocop_config.rs

qlty-cli/src/initializer/renderer.rs

brynary · 2025-08-20T23:43:30Z

qlty-cli/src/initializer/initializer.rs

+                        config_files = custom_cops;
+                    }
+                }
+            }


I agree hard coding a RuboCop specific block into this file is problematic. We can discuss some ways to resolve tomorrow.

My initial idea is that we should handle this similar to the way that we handle customer parsers for plugins....

We can define a trait like CustomPluginEnabler with a TBD interface. Then we define a RuboCopEnabler impl CustomPluginEnabler for the RuboCop specific logic.

To bring it all together we would then add a new property to the TOML plugin definition like this:

custom_enabler = "rubocop" # Use custom enabling logic

This would open the door for us to add custom enablers for any plugin where it is valuable without breaking the abstraction.

qlty-cli/src/initializer/scanner/rubocop_config.rs

qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs

brynary · 2025-10-08T15:31:26Z

qlty-cli/src/initializer/initializer.rs

+                ..Default::default()
+            };
+
+            // Get the plugin definition from scanner's sources_only_config


This comment matched the code in that it gets the plugin definition from the sources_only_config. Why do we do that?

(Ideally the comment should focus on the why and the code is self-explanatory for the what)

qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs

qltysh · 2025-10-09T17:29:49Z

qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs

+                    if path.starts_with("./") || path.contains('/') {
+                        // Remove leading ./ if present
+                        let clean_path = path.strip_prefix("./").unwrap_or(path);
+                        custom_cop_files.insert(clean_path.to_string());


Deeply nested control flow (level = 5) [qlty:nested-control-flow]

Copilot AI review requested due to automatic review settings August 20, 2025 23:24

marschattha requested a review from brynary August 20, 2025 23:24

Copilot AI reviewed Aug 20, 2025

View reviewed changes

qlty-cli/src/initializer/initializer.rs Outdated Show resolved Hide resolved

qlty-cli/src/initializer/scanner/rubocop_config.rs Show resolved Hide resolved

qlty-cli/src/initializer/scanner/rubocop_config.rs Show resolved Hide resolved

qltysh bot reviewed Aug 20, 2025

View reviewed changes

qlty-cli/src/initializer/scanner/rubocop_config.rs Show resolved Hide resolved

brynary reviewed Aug 20, 2025

View reviewed changes

qltysh bot reviewed Aug 21, 2025

View reviewed changes

qlty-cli/src/initializer/scanner/rubocop_config.rs Show resolved Hide resolved

marschattha requested a review from brynary September 1, 2025 19:29

qltysh bot reviewed Sep 1, 2025

View reviewed changes

qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs Show resolved Hide resolved

brynary reviewed Oct 8, 2025

View reviewed changes

qltysh bot reviewed Oct 9, 2025

View reviewed changes

qlty-cli/src/initializer/custom_enabler/rubocop_enabler.rs Show resolved Hide resolved

marschattha added 5 commits October 9, 2025 22:21

Automatically add rubocop requires to config_files

c6f4308

Add renderer unit test

ae5be90

Add custom enabler

a39eb9a

Update comment

8c82c73

Update test

8625e0e

marschattha force-pushed the ma/create_config_files_for_rubocop_requires branch from 528c6df to 8625e0e Compare October 9, 2025 17:25

qltysh bot reviewed Oct 9, 2025

View reviewed changes

marschattha requested a review from brynary October 9, 2025 17:49

feat: automatically add local rubocop requires to config_files #2336

Are you sure you want to change the base?

feat: automatically add local rubocop requires to config_files #2336

Uh oh!

Conversation

marschattha commented Aug 20, 2025

Uh oh!

github-actions bot commented Aug 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qltysh bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh bot commented Aug 20, 2025

1 new issue

Uh oh!

Uh oh!

Uh oh!

brynary Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brynary Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qltysh bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

qltysh bot commented Aug 20, 2025 •

edited

Loading

qltysh bot commented Aug 20, 2025 •

edited

Loading