plop | JavaScript Ecosystem Directory

Bot releases are visible (Hide)

plop - [email protected] Latest Release

Published by crutchcorn 10 months ago

What's Changed

feat: Adds --no-progress flag that disables the progress bar by @rznzippy in https://github.com/plopjs/plop/pull/408
fix(engines): update engines to match top level package by @blabute in https://github.com/plopjs/plop/pull/403
fix(node-plop): type assertion is not working for vm array by @niandalu in https://github.com/plopjs/plop/pull/405
Update All Deps Dec 2023 by @crutchcorn in https://github.com/plopjs/plop/pull/411

New Contributors

@JanThiel made their first contribution in https://github.com/plopjs/plop/pull/378
@blabute made their first contribution in https://github.com/plopjs/plop/pull/403
@niandalu made their first contribution in https://github.com/plopjs/plop/pull/405
@rznzippy made their first contribution in https://github.com/plopjs/plop/pull/408

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@4.0.1

plop - [email protected]

Published by crutchcorn about 1 year ago

The next major release of plop since 2021 is here!

~~We've got a massive feature in this release: TypeScript Configuration File Support. Read further to find out more!~~

Breaking Changes

Node 12, 14, and 16 support has been dropped

Features

TypeScript Configuration Support

~~The major feature of this release is support for TypeScript plopfile.ts files out-of-the-box (https://github.com/plopjs/plop/issues/297). This is a long-standing feature request and it's now live!~~

~~While we have an E2E test to validate that this feature works, please let us know if there's any issues with it.~~

It's clear to us now that this feature wasn't in the oven quite long enough. Please check https://github.com/plopjs/plop/issues/297 for status updates. Apologies for the miscommunication.

New Contributors

@JanThiel made their first contribution in https://github.com/plopjs/plop/pull/378

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@4.0.0

plop - [email protected]

Published by crutchcorn over 1 year ago

What's Changed

Use type alias for inquirer module to avoid typescript error. Closes #357 by @jayalfredprufrock in https://github.com/plopjs/plop/pull/358
Ensure addMany actions strip extensions correctly on dot files by @alarner in https://github.com/plopjs/plop/pull/366
Empty checkbox bypass by @bradgarropy in https://github.com/plopjs/plop/pull/354
fix: Append action's templateFile string not processed by handlebars by @trmnl-cmdr in https://github.com/plopjs/plop/pull/352

New Contributors

@jayalfredprufrock made their first contribution in https://github.com/plopjs/plop/pull/358
@alarner made their first contribution in https://github.com/plopjs/plop/pull/366
@bradgarropy made their first contribution in https://github.com/plopjs/plop/pull/354
@trmnl-cmdr made their first contribution in https://github.com/plopjs/plop/pull/352

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@3.1.2

plop - [email protected]

Published by crutchcorn over 1 year ago

What's Changed

Use type alias for inquirer module to avoid typescript error. Closes #357 by @jayalfredprufrock in https://github.com/plopjs/plop/pull/358
Ensure addMany actions strip extensions correctly on dot files by @alarner in https://github.com/plopjs/plop/pull/366
Empty checkbox bypass by @bradgarropy in https://github.com/plopjs/plop/pull/354
fix: Append action's templateFile string not processed by handlebars by @trmnl-cmdr in https://github.com/plopjs/plop/pull/352

New Contributors

@jayalfredprufrock made their first contribution in https://github.com/plopjs/plop/pull/358
@alarner made their first contribution in https://github.com/plopjs/plop/pull/366
@bradgarropy made their first contribution in https://github.com/plopjs/plop/pull/354
@trmnl-cmdr made their first contribution in https://github.com/plopjs/plop/pull/352

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@0.31.1

plop - [email protected]

Published by crutchcorn over 2 years ago

What's Changed

chore: replace Lerna with Turborepo by @crutchcorn in https://github.com/plopjs/plop/pull/338
chore: Add README.zh.md Related with #257 by @CafuChino in https://github.com/plopjs/plop/pull/342
doc: fix Readme.zh.md by @zhouhaoyiu in https://github.com/plopjs/plop/pull/343
added PlopGeneratorConfig to exports in plop by @naiknareshh in https://github.com/plopjs/plop/pull/341

New Contributors

@CafuChino made their first contribution in https://github.com/plopjs/plop/pull/342
@zhouhaoyiu made their first contribution in https://github.com/plopjs/plop/pull/343
@naiknareshh made their first contribution in https://github.com/plopjs/plop/pull/341

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@3.1.1

plop - [email protected]

Published by crutchcorn over 2 years ago

What's Changed

Shorthand to load all plop assets by @RobinKnipe in https://github.com/plopjs/plop/pull/333

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@3.1.0

plop - [email protected]

Published by crutchcorn over 2 years ago

What's Changed

Shorthand to load all plop assets by @RobinKnipe in https://github.com/plopjs/plop/pull/333

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]@0.31.0

plop - [email protected]

Published by crutchcorn over 2 years ago

This is the first release under the plop monorepo instead of having node-plop in a dedicated repo.

No code changes outside of merging into the monorepo were made.

plop - [email protected]

Published by crutchcorn over 2 years ago

This repo is now a monorepo, which is housed alongside the code for node-plop. All previous releases refer to only plop itself, and not node-plop.

What's Changed

Fixed the issue of 404 doc link. Now the link points to correct example by @atapas in https://github.com/plopjs/plop/pull/309
Monorepo by @crutchcorn in https://github.com/plopjs/plop/pull/313

New Contributors

@atapas made their first contribution in https://github.com/plopjs/plop/pull/309

Full Changelog: https://github.com/plopjs/plop/compare/[email protected]

plop - v3.0.5

Published by crutchcorn almost 3 years ago

What's Changed

chore: update testing dep by @crutchcorn in https://github.com/plopjs/plop/pull/303

Full Changelog: https://github.com/plopjs/plop/compare/v3.0.4...v3.0.5

plop - v3.0.4

Published by crutchcorn almost 3 years ago

What's Changed

Empty prompts should now bypass properly by @Pike in https://github.com/plopjs/plop/commit/1969d45e04575da87224f9a1f3dc980e967188b9

Full Changelog: https://github.com/plopjs/plop/compare/v3.0.3...v3.0.4

plop - v3.0.3

Published by crutchcorn almost 3 years ago

What's Changed

Resolve extension of main field by @ThibodeauJF in https://github.com/plopjs/plop/pull/301

New Contributors

@ThibodeauJF made their first contribution in https://github.com/plopjs/plop/pull/301

Full Changelog: https://github.com/plopjs/plop/compare/v3.0.2...v3.0.3

plop - v3.0.2

Published by crutchcorn almost 3 years ago

What's Changed

Fixed

Return error code on failures on actions by @Pike in https://github.com/plopjs/plop/pull/300

Full Changelog: https://github.com/plopjs/plop/compare/v3.0.1...v3.0.2

plop - v3.0.1

Published by crutchcorn almost 3 years ago

Fixes run typing to be a promise, as was updated in Plop 3

plop - v3.0.0 🎉

Published by crutchcorn almost 3 years ago

The first major release of plop since 2018 is here!

We've got a massive feature in this release: ESM Support. Read further to find out more!

Breaking Changes

Node 8 and 10 support has been dropped
- Node 12 and 14 must be match ^12.20.0 and ^14.13.1 respectively

Wrapper CLI Breaking Changes

This section doesn't apply to users of the plop CLI command, only those that are using plop as a library in their own generator tool.

Plop wrapper CLIs must be ESM to import plop (see below to learn more)
Liftoff has been upgraded from 1 to 4 and as a result, the Plop object API has changed. Instead of:

Plop.launch({
  cwd: argv.cwd,
  configPath: path.join(__dirname, 'plopfile.js'),
  require: argv.require,
  completion: argv.completion
}, env => run(env, undefined, true));

You need to do:

import { dirname } from "node:path";

import { fileURLToPath } from "node:url";

const __dirname = dirname(fileURLToPath(import.meta.url));

Plop.prepare({
  cwd: argv.cwd,
  configPath: path.join(__dirname, 'plopfile.js'),
  preload: argv.preload || [],
  completion: argv.completion
}, env => Plop.execute(env, run));

Features

ESM Support

The major feature of this release is support for ESM modules (https://github.com/plopjs/plop/issues/260)

This means that instead of:

module.exports = (plop) => {
	// ...
}

You can now have the following code in your plopfile:

export default (plop) => {
	// ...
}

Going forward, plopfiles must either be:

An ESM .mjs file with type: "module" in package.json
An ESM .js file with type: "module" in package.json
A CommonJS .cjs file with type: "module" in package.json
A CommonJS .js file with type: "commonjs" in package.json

Any of these file extensions will be recognized and accepted with the default plopfile name, just like before.

If you want to learn more about ESM usage in a library, here's some further reading provided by Sindre Sorhus.

These limitations will also be present for plop wrapper CLIs, so it's encouraged to read the above if you're doing so.

Async Plopfunctions

While previously a plopfile.js had to be a synchronous export - we now allow you to make an async function. We handle the rest!

export default async (plop) => {
	// ...
}

Bug Fixes

TypeScript usage should be more consistent and less buggy: https://github.com/plopjs/node-plop/issues/194
Prompt validators can now be async: https://github.com/plopjs/node-plop/issues/182
Vulnerabilities present in the 2.x release have now been fixed. Unfortunately, we cannot backport this behavior.

Internal Changes

The plop CLI itself now has a solid end-to-end tests. While this isn't done, it is very functional today. These tests have enabled us to be confident that this release should work for 99% of users without having to change much if anything at all on their end.

We even wrote our own testing library to support this

Admittedly, we have a low coverage rate, but are testing against most of the big stuff today. We welcome and encourage pull requests adding more tests to increase that rate.

We've also added CI to run those end-to-end tests against every PR against the main branch.