class method `self.enumerate`

Ruby on Rails 7.2.3

Since v6.0.6

Available in: v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

self.enumerate(tag = nil, options = {})

Prints all annotations with tag tag under the root directories app, config, db, lib, and test (recursively).

If tag is nil, annotations with either default or registered tags are printed.

Specific directories can be explicitly set using the :dirs key in options.

Rails::SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true

If options has a :tag flag, it will be passed to each annotation’s to_s.

See SourceAnnotationExtractor#find_in for a list of file extensions that will be taken into account.

This class method is the single entry point for the rails notes command.

Parameters

tag opt = nil
options opt = {}

Source

# File railties/lib/rails/source_annotation_extractor.rb, line 128
    def self.enumerate(tag = nil, options = {})
      tag ||= Annotation.tags.join("|")
      extractor = new(tag)
      dirs = options.delete(:dirs) || Annotation.directories
      extractor.display(extractor.find(dirs), options)
    end

Defined in railties/lib/rails/source_annotation_extractor.rb line 128 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Rails::SourceAnnotationExtractor

Signature

Parameters