plop

This release enables easier wrapping around the plop utility in another CLI tool. Follow the documentation for more

• Add export of run, progress spinner functions
• Add export of Liftoff type in typescript

• Fixes various typing issues
• Remove packages with stub typings
• Enables CLI tools to merge the props before and after the --. See the docs for more: https://github.com/plopjs/plop#wrapping-plop

This does not change the default behavior of Plop itself

• typescript typings have been improved
• added an optional transform function for add, addMany, and modify that allows the action output to be transformed before writing the file to disk.
• the modify action now can accept one or both of pattern and transform but fails with a useful error if neither are provided.
• adds an optional skip function for all actions. Check the README for further documentation

Huge thank you to @jacksteamdev for making this release possible

• fixed issues with using .ts files
• fixed typescript typings

• more typescript updates

• fixes TypeScript export

• fixes issue with unique behavior of append action when pattern is a string

• adds --dest CLI switch to allow users to use a destination base path other than the plopfile folder.
• improved support for Windows
• fixes for bypass incompatibility with inquirer prompt functions
• adds TypeScript definitions from node-plop
• updates many dependencies

• Adds new way to bypass prompts (by Name)
• Fixes issue with action data leaking to future actions

General Improvements

• Action status is now reported as it comes in, instead of being logged all at once after everything is complete. This is particularly nice if you have async actions.
• Adds support for comments in the actions array that are outputted to the results screen.
• Now uses ora to output action results and show spinners.
• Shortens built-in action names in the results output to a 2 character abbreviation (param available to show full action type names)
• Various bug fixes

Updated Actions

• addMany has a new verbose option that can be set to false to prevent the actions from listing all files that it adds. Instead it only reports the number of files added.

• add and addMany now support binary files. Binary files will be copied to the destination folder, but not processed by handlebars.
• pattern attribute of append action is now optional. If not supplied, the template will be appended to the end of the file.
• The data property of the ActionConfig interface can now be a function that returns an Object or a Promise that resolves with an Object.

Fixes

• Answer data can once again be changed from within an action function
• Prompt validate functions now run against bypass data

Major version changed due to inquirer.js changing its node version requirements. Plop 2.x now requires Node 8.9.4 or greater. There should be no breaking changes in the API itself.

• added optional data property for all actions that can be used in the template
• added force option for all actions with CLI ability to run actions forcibly
• added skipIfExists option for add and addMany actions
• added append action (similar to modify)

• Added new prompt bypass support
• Added new custom welcome message support via (setWelcomeMessage)
• Added support for handlebar templates for the templateFile prop of add and addMany actions
• Fixed defect in addMany action on Windows

Big thanks to @nicoespeon and @Tsur for their help with this release!

the addMany action was choking on a globby array, now it does not 🙂

• support for creating your own custom actions
• new built-in action (addMany)
• support for inquirer hierarchical prompts
• better --help screen

Big thanks to @nicoespeon and @filipemir for their help in getting this together.

Node 4 babel compatibility hotfix added in node-plop

• fixed pkg helper functionality
• explicitly set plopfilePath to process.cwd() if it's not provided

• fixes a defect with path resolution on Windows
• fixes syntax error on older versions of node

Added plop.load feature 💥