rubocop-yardoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c426a883ef24b7fbb8e51fd209e6052c093d154c5ea17266eaae980d9f31299a
+  data.tar.gz: b516cccfb30b937874169ca12a344bbb6fd12b878427ddb0bad5c05cda799903
+SHA512:
+  metadata.gz: c74648386bcf3bd50f07f884e3530e0ef7e565fdb434a5d809883937738828c77a09ac0947c9adabb6aeb3858541793870e80a9f2eeb0ee5394d353a3fbee41d
+  data.tar.gz: 6bb39ddbef6f814afd4d863838f54fb3980e8087e0754a97734e27ac90a1f94036ff93922276a01b2ee2a313bf79cbcc2cd421a5618b5aeee4da8b47999b34f1

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-08-04
+
+- Initial release with following cops:
+  - `Yardoc/ClassDescription`:  Ensure that classes are documented, with an ignore list of names
+  - `Yardoc/ColumnParams`: Ensure that parameters elements are aligned
+  - `Yardoc/ConstantDescription`:  Ensure that constants are documented, with an ignore list of names
+  - `Yardoc/MethodDescription`:  Ensure that methods have a description, with an ignore list of names
+  - `Yardoc/ModuleDescription`: Ensure that modules are documented, with an ignore list of names
+  - `Yardoc/ParamDescriptionCasing`: Ensure that the first letter of a parameter is an uppercase letter
+  - `Yardoc/ParamDocumentation`: Ensure that parameters are fully documented (type and description), with an option to
+     ignore description
+  - `Yardoc/SeparateTagsBlocks`: Ensure consecutive blocks of the same tag are separated with empty spaces from other
+    tags
+  - `Yardoc/SupportedTags`: Ensure that tags used in documentation are supported by Yardoc (base + custom registered ones),
+     with an ignore list
+  - `Yardoc/TagOrder`: Ensure that tags follows a defined order in the documentation block, with option to re-define the
+     list
+  - `Yardoc/YieldDocumentation`: Ensure that blocks and block arguments are documented, with an option to disable
+     arguments check.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# Code of Conduct - RuboCop Yardoc
+
+## Our pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`contact-project+experimentslabs-rubocop-yardoc-85063958-issue-@incoming.gitlab.com`.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

data/CONTRIBUTING.md

@@ -0,0 +1,213 @@
+<!-- omit in toc -->
+# Contributing to RuboCop Yardoc
+<!-- Keep the toc for the documentation app -->
+[[TOC]]
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways
+to help and details about how this project handles them. Please make sure to read the relevant section before making
+your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The
+community looks forward to your contributions.
+
+And if you like the project, but just don't have time to contribute, that's fine. Speaking about it to people that might
+be interested is already a contribution :)
+
+<!-- omit in toc -->
+## Table of contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
+
+
+## Code of conduct
+
+This project and everyone participating in it is governed by the
+[Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior to
+`contact-project+experimentslabs-rubocop-yardoc-85063958-issue-@incoming.gitlab.com`. Received emails are not
+public.
+
+
+## I Have a question
+
+Before you ask a question, it is best to search for
+existing [Issues](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues) that might help you. In case
+you have found a suitable issue and still need clarification, you can write your question in this issue. It is also
+advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues/new).
+- Provide as much context as you can about what you're running into (try to fill the provided template).
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+You also can reach us on our Matrix chatrooms (listed in the [README](README.md))
+
+## I want to contribute
+
+> ### Legal notice <!-- omit in toc -->
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the
+> necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting bugs
+
+#### Before submitting a bug report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to
+investigate carefully, collect information and describe the issue in detail in your report. Please complete the
+following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
+  components/versions (Make sure that you have read the documentation (check the [README](README.md) for a full list).
+  If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there
+  is not already a bug report existing for your bug or error in
+  the [bug tracker](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues/-/issues?label_name[]=Type%3A%3ABug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitLab community have
+  discussed the issue.
+- Collect information about the bug:
+  - Stack trace (Traceback)
+  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How do I submit a good bug report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
+> tracker, or elsewhere in public.
+> Instead sensitive bugs must be sent by email to
+> contact-project+experimentslabs-rubocop-yardoc-85063958-issue-@incoming.gitlab.com.
+
+We use GitLab issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues/issues/new). (Since we can't be
+  sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to
+  recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem
+  and create a reduced test case.
+- Provide the information you collected in the previous section, in the issue template.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no
+  obvious way to reproduce the issue, the team will ask you for those steps and mark the issue
+  as `Status::Needs reproduction`. Bugs with the `Status::Needs reproduction` tag will not be addressed until they are
+  reproduced.
+- If the team is able to reproduce the issue, it will be marked `Status::Available`, as well as possibly other tags, and
+  the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting enhancements
+
+This section guides you through submitting an enhancement suggestion for _RuboCop Yardoc_, **including completely new
+features and minor improvements to existing functionality**.
+Following these guidelines will help maintainers and the community to understand your suggestion and find related
+suggestions.
+
+<!-- omit in toc -->
+#### Before submitting an enhancement
+
+- Make sure that you are using the latest version.
+- Read the documentation (check the [README](README.md) for a full list) carefully and find out if the functionality is
+  already covered, maybe by an individual configuration.
+- Perform a [search](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues/issues) to see if the
+  enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to
+  convince the project's developers of the merits of this feature. Keep in mind that we want features that will be
+  useful to the majority of our users and not just a small subset. If you're just targeting a minority of users,
+  consider writing an add-on/plugin library.
+
+<!-- omit in toc -->
+#### How do I submit a good enhancement suggestion?
+
+Enhancement suggestions are tracked as [GitLab issues](https://gitlab.com/experimentslabs/rubocop-yardoc/-/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion. It still may be changed by maintainers
+  if they think it's unclear.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point
+  you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part
+  which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS
+  and Windows, and [this tool](https://github.com/colinkeenan/silentcast)
+  or [this tool](https://github.com/GNOME/byzanz) on Linux.
+- **Explain why this enhancement would be useful** to most RuboCop Yardoc users. You may also want to point out the other
+  projects that solved it better and which could serve as inspiration.
+
+Maintainers will review the suggestion add the appropriate tags to the ticket as soon as possible.
+
+### Your first code contribution
+
+To make a code contribution, you should follow these steps:
+
+1. Fork the repository and clone it on your computer (or synchronize your local fork with the main repository).
+1. Check the [README](README.md) to get started with the project on your machine
+1. Create a branch from (`develop`) and make your fixes. Don't forget to add or update tests related to your work. We
+   use the [conventional commits](https://www.conventionalcommits.org) specification here for our commit messages.
+1. Make sure the tests suites and linters pass (RuboCop, RSpec).
+1. You updated the changelog for non-documentational changes (`CHANGELOG.md`).
+1. Push your work and open a merge request on the RuboCop Yardoc repository, explaining your changes. The merge request form
+   contains templates with a few things to do/keep in mind.
+1. Check for comments and/or changes requests until a maintainer merges the request.
+
+Note that if you're not so comfortable with git, you can state it in the MR, and a maintainer _may_ rebase/cleanup the
+commits.
+
+## Styleguides
+
+### Commit Messages
+
+This project follow the [conventional commits](https://www.conventionalcommits.org) specification for commit messages.
+
+As a reminder, these _types_ are already used:
+
+- `feat` - This commit introduces a new feature or enhancement.
+- `fix` - This commit fixes something.
+- `rework` - This commit does not add anything but makes the code better.
+- `chore` - This commit is a bit boring: code linting, generating files, adding dependencies, splitting files,
+  updating, ...
+- `release` - This commit marks a release preparation: changes in the migration guide, changelogs, version bump, ...
+
+We are less strict on the _scope_, except for a few of them:
+
+- `ruby` - Related to ruby dependencies
+
+Beside these two, look at the commit log if you need inspiration
+
+### Markdown
+
+There is no tool to enforce Markdown files format, but we try to follow these conventions:
+
+- Lines are at most 120 characters long
+- use one dash for emphasis `_text_`
+- use double asterisk for bigger emphasis `**text**`
+
+Everything else is pretty free for now.
+
+## Join the project team
+
+You want to be part of the maintainers? Great!
+
+You will need to have a good general understanding of the project and code, or at least on a part of it.
+
+Be a living part of the community by joining the chatrooms (see the [README](README.md) for links), participating on
+issues, and ideally have some merge requests... merged.
+
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Experiments Labs / Rubocop Yardoc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# RuboCop Yardoc
+
+A RuboCop plugin to lint documentation comments in Ruby files.
+
+## Community
+
+- [Matrix chatroom](https://matrix.to/#/#experimentslabs-general:matrix.org)
+
+## Documentation
+
+- Community-related:
+  - [Code of conduct](CODE_OF_CONDUCT.md)
+- Development-related:
+  - [Contribution guide](CONTRIBUTING.md)
+  - _This file_
+- Provided cops: **For now, refer to examples in `lib/rubocop/cop/yardoc/*`.**
+
+_Todo_ : Gitlab pages with cop documentation, Markdown cop documentation from sources.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rubocop-yardoc
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rubocop-yardoc
+```
+
+## Usage
+
+Add `rubocop-yardoc` to the plugins list in the RuboCop configuration:
+
+```yml
+# .rubocop.yml
+plugins:
+  - rubocop-yardoc
+```
+
+Then, run RuboCop as usual.
+
+## Cops
+
+_TODO_
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `lib/rubocop/yardoc/version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/experimentslabs/rubocop-yardoc.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://gitlab.com/experimentslabs/rubocop-yardoc/-/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the RuboCop Yardoc project's codebases, issue trackers, chat rooms and mailing lists is expected
+to follow the [code of conduct](https://gitlab.com/experimentslabs/rubocop-yardoc/-/blob/main/CODE_OF_CONDUCT.md).

data/config/default.yml

@@ -0,0 +1,62 @@
+# This is the default configuration file.
+
+Yardoc:
+  Enabled: true
+  DocumentationBaseURL: __FIXME__
+
+Yardoc/ClassDescription:
+  Enabled: true
+  # Use plain strings or regular expressions to match names and fully qualified names
+  Ignore: []
+
+Yardoc/ColumnParams:
+  Enabled: true
+
+Yardoc/ConstantDescription:
+  Enabled: true
+  # Use plain strings or regular expressions to match names and fully qualified names
+  Ignore: []
+
+Yardoc/MethodDescription:
+  Enabled: true
+  DocumentPrivate: true
+  # Use plain strings or regular expressions to match names and fully qualified names
+  Ignore: []
+
+Yardoc/ModuleDescription:
+  Enabled: true
+  # Use plain strings or regular expressions to match names and fully qualified names
+  Ignore: []
+
+Yardoc/ParamDescriptionCasing:
+  Enabled: true
+
+Yardoc/ParamDocumentation:
+  Enabled: true
+  RequireDescription: true
+
+Yardoc/SeparateTagsBlocks:
+  Enabled: true
+
+Yardoc/SupportedTags:
+  Enabled: true
+  AdditionalTags: []
+
+Yardoc/TagOrder:
+  Enabled: true
+  Order:
+    - deprecated
+    - param
+    - return
+    - yieldparam
+    - yieldreturn
+    - option
+    - raise
+    - see
+    - since
+    - note
+    - example
+
+Yardoc/YieldDocumentation:
+  Enabled: true
+  RequireParamDocumentation: true

data/config/obsoletion.yml

@@ -0,0 +1,3 @@
+# Configuration for obsoletion.
+#
+# See: https://docs.rubocop.org/rubocop/latest/plugin_configuration.html#config-obsoletions

data/lib/rubocop/cop/mixin/node_name_help.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Helper methods to work with Rubocop node names
+    module NodeNameHelp
+      # Resolves the fully-qualified name of a module or class node
+      # by walking up the ancestor chain.
+      #
+      # @param node [RuboCop::AST::Node] Module or class node
+      #
+      # @return [String] Fully-qualified name
+      def fully_qualified_name(node)
+        parts = []
+        current = node
+
+        while current
+          parts.unshift(current.children.first.const_name) if current.module_type? || current.class_type?
+          current = current.parent
+        end
+
+        parts.join('::')
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/param_help.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Helper methods to work with node parameters
+    module ParamHelp
+      # Returns the location of "@<tag_name>" of the `comment_line` in the
+      # source buffer
+      #
+      # @param comment_line [Parser::Source::Comment] Comment line
+      # @param tag_name     [String]                  Name of the tag
+      def start_tag_position(comment_line, tag_name)
+        comment_range = comment_line.loc.expression
+        at_pos        = comment_line.text.index('@')
+
+        Parser::Source::Range.new processed_source.buffer,
+                                  comment_range.begin_pos + at_pos,
+                                  comment_range.begin_pos + at_pos + tag_name.length + 1
+      end
+
+      # Extracts "@param" tags and their position in comment block
+      #
+      # @param node [RuboCop::AST::Node] The AST node
+      #
+      # @return [Array<Hash>]
+      def param_tags_and_positions(node) # rubocop:disable Metrics/MethodLength
+        node_comments = processed_source.ast_with_comments.fetch(node, [])
+        param_tags = yard_tags(node).select { |t| t.tag_name == 'param' }
+
+        # Try to match extracted yard tags and source comments
+        param_tags.map do |param|
+          source_comment = node_comments.find { |comment| comment.text.match?(/@param\s+#{param.name}/) }
+
+          {
+            name:     param.name,
+            source:   source_comment.source,
+            comment:  source_comment,
+            yard_tag: param,
+            range:    start_tag_position(source_comment, 'param'),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/yard_help.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Helper methods to work with Yard parsed strings
+    module YardHelp
+      private
+
+      # Extracts the YARD docstring immediately preceding a node.
+      #
+      # @param node [RuboCop::AST::Node] The AST node to find docs for
+      #
+      # @return [YARD::DocstringParser, nil] Parsed docstring or nil if none found
+      def yard_docstring(node)
+        comments = processed_source.ast_with_comments[node]
+        return nil if comments.nil? || comments.empty?
+
+        comment_text = comments.map { |c| c.text.sub(/^#\s?/, '') }.join("\n")
+        YARD::DocstringParser.new.parse(comment_text)
+      end
+
+      # Returns all YARD tags from the docstring preceding a node.
+      #
+      # @param node [RuboCop::AST::Node] The AST node
+      #
+      # @return [Array<YARD::Tags::Tag>] List of tags
+      def yard_tags(node)
+        docstring = yard_docstring(node)
+        return [] if docstring.nil?
+
+        docstring.tags
+      end
+    end
+  end
+end

data/lib/rubocop/cop/yardoc/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Yardoc
+      # Base class that provides shared YARD parsing utilities for all YARD cops.
+      class Base < RuboCop::Cop::Base
+        private
+
+        # Checks whether a node has any preceding documentation comments.
+        #
+        # @param node [RuboCop::AST::Node] The AST node
+        #
+        # @return [Boolean]
+        def documented?(node)
+          comments = processed_source.ast_with_comments[node]
+          comments && !comments.empty?
+        end
+
+        # Checks whether a name matches any entry in an ignore list from cop configuration.
+        # Entries may be plain strings or /regexp/ strings.
+        #
+        # @param name [String]        The fully-qualified name to check
+        # @param list [Array<String>] List of names or /pattern/ strings
+        #
+        # @return [Boolean]
+        def ignored?(name, list)
+          list.any? do |pattern|
+            if pattern.start_with?('/') && pattern.end_with?('/')
+              Regexp.new(pattern[1..-2]).match?(name)
+            else
+              name == pattern
+            end
+          end
+        end
+
+        # List of symbols ignored for the cop
+        def ignore_list
+          Array(cop_config['Ignore'])
+        end
+      end
+    end
+  end
+end