如何用注释gem来注释rails引擎模型？

Question

我正在尝试在 rails 6 项目中注释我的引擎。

在 gem 文件中的根应用程序上

group :development do
  gem 'annotate'
end

这和预期的一样有效。当我每次运行迁移时，我的所有模型都完美注释

现在我的引擎 Gemfile 路径是 components/engine_mame/Gemfile

我有

source 'https://rubygems.org'
git_source(:github) { |repo| "https://github.com/#{repo}.git" }

# Specify your gem's dependencies in engine_mame.gemspec.
gemspec

group :development do
  gem 'annotate'
  gem 'pg'
end

但是当我查看引擎中的模型时，我没有任何注释。我不确定我做错了什么

谢谢

Answer 1

方法 1：使用生成的 rake 任务 (rails g annotate:install) 设置模型路径，在那里寻找 model_dir 并使用逗号分隔符设置路径，例如

Annotate.set_defaults(
  'model_dir' => 'app/models, engine_mame/app/models',
)

方法 2：在每次调用时手动设置路径（以逗号分隔，没有 space）

bundle exec annotate --model-dir app/models,engine_mame/app/models

如何用注释gem来注释rails引擎模型？

How to annotate rails engine models with the annotate gem?

ruby-on-rails

annotate

rails-engines