class method `self.enumerate`

Ruby on Rails 4.0.13

Since v2.2.3 Last seen in v5.2.8.1

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1

Compare with:

self.enumerate(tag, options={})

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

Additional directories may be added using a comma-delimited list set using ENV['SOURCE_ANNOTATION_DIRECTORIES'].

Directories may also be explicitly set using the :dirs key in options.

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 #find_in for a list of file extensions that will be taken into account.

This class method is the single entry point for the rake tasks.

Parameters

tag req
options opt = {}

Source

# File railties/lib/rails/source_annotation_extractor.rb, line 49
  def self.enumerate(tag, options={})
    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 49 · View on GitHub · Improve this page · Find usages on GitHub

Defined in SourceAnnotationExtractor

Signature

Parameters