Merge pull request #14 from peterlenagh/feat/optional-hbs-extensions-in-templates

feat(templates): support optional .hbs extensions in templates.

Author: fmvilas

README.md

@@ -83,11 +83,11 @@ And some template files like this:
 ```
 |- index.js            // This file contains static code, e.g. starting a webserver and including ./api/index.js
 |+ api/
- |- index.js           // This is a static template, it contains placeholders that will be filled in, e.g. includes for each file in routes
+ |- index.js.hbs       // This is a static template, it contains placeholders that will be filled in, e.g. includes for each file in routes
  |+ routes/
-  |- $$path$$.route.js      // This file will be generated for each operation and contains skeleton code for each method for an operation.
+  |- $$path$$.route.js.hbs      // This file will be generated for each operation and contains skeleton code for each method for an operation.
 ```
-The first important thing to notice here is the variable notation in `$$path$$.route.js`. It will be replaced by the name of the path.
+The first important thing to notice here is the variable notation in `$$path$$.route.js.hbs`. It will be replaced by the name of the path.
 
 In this example the generated directory structure will be like this:
 ```
@@ -101,6 +101,15 @@ In this example the generated directory structure will be like this:
                        // (e.g. postUserLogin, getUserByUsername, putUserByUsername, deleteUserByUsername).
 ```
 
+### Template file extensions
+You can (optionally) name your template files with `.hbs` extensions, which will be removed when writing the generated
+file. e.g. `index.js.hbs` writes `index.js`. `index.js` would also write to `index.js`, if you prefer to omit the hbs
+extension.
+
+The only case where the `.hbs` extension isn't optional would be if you are writing handlebars templates with the
+templates. In that case the the template would need the extension `.hbs.hbs`. `usertpl.hbs.hbs` writes `usertpl.hbs`
+(but `usertpl.hbs` as a source would write `usertpl` with no extension).
+
 ### Template file content
 The generator passes the OpenAPI spec to template files, so all information should be available there.
 In addition to that, the code generator adds a bit [more data](#data-passed-to-handlebars-templates) that can be helpful.

lib/generator.js

@@ -45,8 +45,7 @@ const generateFile = options => new Promise((resolve, reject) => {
       const template = Handlebars.compile(content);
       const parsed_content = template(data);
       const template_path = path.relative(templates_dir, path.resolve(root, file_name));
-      const generated_path = path.resolve(target_dir, template_path);
-
+      const generated_path = path.resolve(target_dir, template_path).replace(/.hbs$/, '');
       fs.writeFile(generated_path, parsed_content, 'utf8', (err) => {
         if (err) return reject(err);
         resolve();
@@ -69,7 +68,7 @@ const generateOperationFile = (config, operation, operation_name) => new Promise
   fs.readFile(path.join(config.root, config.file_name), 'utf8', (err, data) => {
     if (err) return reject(err);
     const subdir = config.root.replace(new RegExp(`${config.templates_dir}[/]?`),'');
-    const new_filename = config.file_name.replace('$$path$$', operation_name);
+    const new_filename = config.file_name.replace('$$path$$', operation_name).replace(/.hbs$/, '');
     const target_file = path.resolve(config.target_dir, subdir, new_filename);
     const template = Handlebars.compile(data.toString());
     const content = template({

lib/register-partial.js

@@ -8,6 +8,12 @@ const getFileContent = filePath => {
 };
 
 module.exports = async filePath => {
-  const partialName = _.camelCase(path.basename(filePath, path.extname(filePath)));
+  let extname = path.extname(filePath);
+  // rm 2 extensions if the last is .hbs e.g. .md.hbs
+  if (extname === ".hbs") {
+    const filePathSansExt = filePath.replace(extname, "");
+    extname = path.extname(filePathSansExt) + extname;
+  }
+  const partialName = _.camelCase(path.basename(filePath, extname));
   Handlebars.registerPartial(partialName, getFileContent(filePath));
 };