From d40d241e72905dc044f771af5989f3b56809b61d Mon Sep 17 00:00:00 2001
From: Joffrey JAFFEUX <j.jaffeux@gmail.com>
Date: Thu, 30 Aug 2018 12:16:37 +0200
Subject: [PATCH] DEV: adds --help --no-help options to plugin generator
 (#6338)

help will add helpful comments in the various generated files
---
 lib/generators/plugin/plugin_generator.rb          | 1 +
 lib/generators/plugin/templates/javascript.es6.erb | 4 ++++
 lib/generators/plugin/templates/plugin.rb.erb      | 4 ++++
 3 files changed, 9 insertions(+)

diff --git a/lib/generators/plugin/plugin_generator.rb b/lib/generators/plugin/plugin_generator.rb
index 6f371e1e85a..963032784c4 100644
--- a/lib/generators/plugin/plugin_generator.rb
+++ b/lib/generators/plugin/plugin_generator.rb
@@ -10,6 +10,7 @@ class PluginGenerator < Rails::Generators::NamedBase
   class_option :stylesheet, type: :boolean, desc: "Generate Stylesheet", default: true
   class_option :javascript, type: :boolean, desc: "Generate Javascript initializer", default: true
   class_option :scheduled_job, type: :boolean, desc: "Generate scheduled job", default: false
+  class_option :help, type: :boolean, desc: "Adds help comments in generated files", default: true
 
   def create_scheduled_job_file
     return unless @options['scheduled_job']
diff --git a/lib/generators/plugin/templates/javascript.es6.erb b/lib/generators/plugin/templates/javascript.es6.erb
index 566b1ede916..37fb2881c6b 100644
--- a/lib/generators/plugin/templates/javascript.es6.erb
+++ b/lib/generators/plugin/templates/javascript.es6.erb
@@ -1,6 +1,10 @@
 import { withPluginApi } from "discourse/lib/plugin-api";
 
 function initialize<%= classified_name %>(api) {
+  <% if @options['help'] %>
+  // see app/assets/javascripts/discourse/lib/plugin-api
+  // for the functions available via the api object
+  <% end %>
 }
 
 export default {
diff --git a/lib/generators/plugin/templates/plugin.rb.erb b/lib/generators/plugin/templates/plugin.rb.erb
index 55a3dec64c8..031c366ddcb 100644
--- a/lib/generators/plugin/templates/plugin.rb.erb
+++ b/lib/generators/plugin/templates/plugin.rb.erb
@@ -13,6 +13,10 @@ enabled_site_setting :<%= underscored_name %>_enabled
 PLUGIN_NAME ||= "<%= name %>".freeze
 
 after_initialize do
+  <% if @options['help'] %>
+  # see lib/plugin/instance.rb for the methods available in this context
+  <% end %>
+
   module ::<%= classified_name %>
     class Engine < ::Rails::Engine
       engine_name PLUGIN_NAME