class method `self.invoke`

Ruby on Rails 7.0.10

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 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.invoke(namespace, args = ARGV, config = {})

Receives a namespace, arguments, and the behavior to invoke the generator. It’s used as the default entry point for generate, destroy, and update commands.

Parameters

namespace req
args opt = ARGV
config opt = {}

Source

# File railties/lib/rails/generators.rb, line 259
      def invoke(namespace, args = ARGV, config = {})
        names = namespace.to_s.split(":")
        if klass = find_by_namespace(names.pop, names.any? && names.join(":"))
          args << "--help" if args.empty? && klass.arguments.any?(&:required?)
          klass.start(args, config)
          run_after_generate_callback if config[:behavior] == :invoke
        else
          options = sorted_groups.flat_map(&:last)
          error   = Command::Base::CorrectableError.new("Could not find generator '#{namespace}'.", namespace, options)

          if error.respond_to?(:detailed_message)
            formatted_message = error.detailed_message
          else
            formatted_message = error.message
          end

          puts <<~MSG
            #{formatted_message}
            Run `bin/rails generate --help` for more options.
          MSG
        end
      end

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

Defined in Rails::Generators

Signature

Parameters