Rails：使用 rake:javascript 的注释

Question

有没有办法配置 rake:notes 来解析 javascript 文件并发出相应的注释？ 谢谢

Answer 1

如果您愿意，您可以直接使用 grep 执行此操作

grep -r 'OPTIMIZE:\|FIXME:\|TODO:' public/javascripts

如果您只想要 TODO，

grep -r 'TODO:' public/javascripts # Find on todos

您可以使用以下命令来搜索项目中的所有 js，而不仅仅是公共 javascript 下的文件。

grep -r 'OPTIMIZE:\|FIXME:\|TODO:' **/*.js

以下是如何将其转变为 rake 任务。

# File lib/tasks/notes.rake

namespace :notes do
  task :js do
    puts `grep -r 'OPTIMIZE:\\|FIXME:\\|TODO:' public/javascripts`
  end
end

现在您可以从项目根目录执行rakenotes:js。

Answer 2

在 Rails 4.2 中，您已经支持 javascript 注释，但如果您想为其他扩展添加注释，请将此行添加到您的 config/application.rb 文件中：

config.annotations.register_extensions("ext1", "ext2", "txt3") { |annotation| /\/\/\s*(#{annotation}):?\s*(.*)$/ }