feat(plop): add option to use custom templates

[connor-baer]

Purpose

I've worked on several projects where the default templates didn't match the custom project setup.

Approach & changes

• add a custom opts parameter to the Plop config file
• add the templateDir and templateExtension options
• add documentation

Plop will first check for a custom template and fall back to the default template. This makes it easy to override just one or some of the templates.

[felixjung]

Thanks for adding this. Since this doesn't change the kinds of templates supported, I'm assuming this is for cases where you, for example, would like to have ts or flow templates?

Are the existing templates up-to-date? 😀

[afonsodelgado]

Super nice feature! Thank you for adding this! :)

[connor-baer]

@felixjung You're right, it doesn't change the supported templates or prompt. I think this would be much harder to customize because Foundry's plop config contains a lot of custom code. You'd probably be better off adding a custom generator:

const configFn = require('@sumup/foundry/plop').react;

module.exports = plop => {
  plop.setGenerator('Vue', {
    description: 'Generate a new Vue component',
    prompts: [], // array of inquirer prompts
    actions: []  // array of actions
  });
  return configFn(plop);
};

I'll add some documentation about this in a follow-up PR.

Regarding the support for TypeScript, this is also not possible with this PR since the file extensions are still hard-coded. We could add another option to set the language/compiler. WDYT?

const configFn = require('@sumup/foundry/plop').react;

const opts = {
  language: 'TypeScript' | 'JavaScript'
}

module.exports = plop => configFn(plop, opts);

My motivation for this change was, in fact, to use custom Flow templates on the partner portal. Flow works with the .js extension.

Edit: I've added an option to customize the template extension.

[connor-baer]

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀