add comments

bin/generate-plugin-definitions-source.js

@@ -1,11 +1,20 @@
+/**
+ * the tool for genetion of plugin definitions source code
+ *
+ * @author Yuki Takei <yuki@weseek.co.jp>
+ */
 const fs = require('graceful-fs');
 const slash = require('slash');
 const swig = require('swig');
 const helpers = require('../config/helpers');
 
+const TEMPLATE = helpers.root('bin/templates/plugin-definitions.js.swig');
+const OUT = helpers.root('resource/js/plugins/plugin-definitions.js');
+
 const PluginUtils = require('../lib/plugins/plugin-utils');
 const pluginUtils = new PluginUtils();
 
+// get definitions
 const definitions = pluginUtils.listPluginNames(helpers.root())
   .map((name) => {
     return pluginUtils.generatePluginDefinition(name, true);
@@ -18,9 +27,8 @@ const definitions = pluginUtils.listPluginNames(helpers.root())
     return definition;
   });
 
-var template = swig.compileFile(helpers.root('bin/templates/plugin-definitions.js.swig'));
-var output = template({definitions});
+var compiledTemplate = swig.compileFile(TEMPLATE);
+var code = compiledTemplate({definitions});
 
-fs.writeFileSync(
-  helpers.root('resource/js/plugins/plugin-definitions.js'),
-  output);
+// write
+fs.writeFileSync(OUT, code);

bin/templates/plugin-definitions.js.swig

@@ -1,6 +1,9 @@
+/*
+ * !! don't commit this file !!
+ * !!      just revert       !!
+ */
 export const definitions = [
-  {% for definition in definitions %}
-  {
+  {% for definition in definitions %}{
     name: '{{ definition.name }}',
     meta: require('{{ definition.name }}'),
     entries: [
@@ -10,4 +13,5 @@ export const definitions = [
     ]
   },
   {% endfor %}
+
 ]

resource/js/plugins/plugin-definitions.js

@@ -1,2 +1,3 @@
 export const definitions = [
+  // plugin definitions will be generated by /bin/generate-plugin-definitions-source.js
 ]