Skip to content

chore: Add missing examples to cops

Mohammed Firdous requested to merge gitlab-community/ruby/gems/gitlab-styles:77-add-missing-cop-examples into master
  • Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you can request access to GitLab Duo.

Add missing examples to cops

This MR adds missing "# good" and "# bad" examples to several cops in the repository. These examples will be used to generate documentation in the future.

Changes made:

  • Added examples to the following cops:

    • FIPS/MD5
    • FIPS/OpenSSL
    • FIPS/SHA1
    • GemFetcher
    • GitlabSecurity/DeepMunge
    • InBatches
    • InternalAffairs/DeprecateCopHelper
    • LineBreakAroundConditionalBlock
    • Migration/UpdateLargeTable
    • Performance/Rubyzip
    • PolymorphicAssociations

  • Regenerated the .rubocop_todo.yml file

Related issues

Fixes #77

Next steps:

  • Review the added examples for correctness and clarity
  • Ensure that the regenerated .rubocop_todo.yml file doesn't introduce any unexpected changes

The merge request updates the Gitpod and Rubocop configuration files, and modifies several Ruby code files. It deprecates the use of CopHelper and in_batches methods, and suggests alternatives to improve code security and performance.

Edited by Mohammed Firdous

Merge request reports