fix(deps): update dependency plop to v3

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
plop (source)	^2.7.6 -> 3.0.1

---

Release Notes

plopjs/plop

v3.0.1

Compare Source

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

v3.0.0

Compare Source

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.

Looking Ahead

While this release is fun, there's more that we want to do internally sometime in the near future.

Namely:

• Simplify node-plop tests
• Migrate node-plop to use jest instead of ava
• Move node-plop to monorepo in the plop repo
• Add commit hooks and autogenerated changelog to node-plop and plop
• Rename branches from master to main
• Add TS example tests to plop

---

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by WhiteSource Renovate. View repository job log here.

[renovate]

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: pnpm-lock.yaml

npm notice 
npm notice New patch version of npm available! 8.1.0 -> 8.1.4
npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.1.4>
npm notice Run `npm install -g [email protected]` to update!
npm notice 

[vercel]

Deployment failed with the following error:

The most recent charge for your active payment method has failed. Please update it here: https://vercel.com/teams/dgiot-dashboard/settings/billing.

[pull-checklist]

Pull Checklist Limit Reached

We're sorry you've reached your plans limit of 10 Protected Pull Requests per month.

If you find Pull Checklist valuable and would like to upgrade your plan please click here otherwise your limit will reset in 1 days.

[pull-request-quantifier-deprecated]

This PR has 2 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

---

Quantification details

Label      : Extra Small
Size       : +1 -1
Percentile : 0.8%

Total files changed: 1

Change summary by file extension:
.json : +1 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

• Fast and predictable releases to production:
  • Optimal size changes are more likely to be reviewed faster with fewer
    iterations.
  • Similarity in low PR complexity drives similar review times.
• Review quality is likely higher as complexity is lower:
  • Bugs are more likely to be detected.
  • Code inconsistencies are more likely to be detetcted.
• Knowledge sharing is improved within the participants:
  • Small portions can be assimilated better.
• Better engineering practices are exercised:
  • Solving big problems by dividing them in well contained, smaller problems.
  • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

• Use the PullRequestQuantifier to quantify your PR accurately
  • Create a context profile for your repo using the context generator
  • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
  • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
  • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
• Change your engineering behaviors
  • For PRs that fall outside of the desired spectrum, review the details and check if:
    • Your PR could be split in smaller, self-contained PRs instead
    • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

• One line was added: +1 -0
• One line was deleted: +0 -1
• One line was modified: +1 -1 (git diff doesn't know about modified, it will
  interpret that line like one addition plus one deletion)
• Change percentiles: Change characteristics (addition, deletion, modification)
  of this PR in relation to all other PRs within the repository.

---

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

[renovate]

Renovate Ignore Notification

As this PR has been closed unmerged, Renovate will ignore this upgrade and you will not receive PRs for any future 3.x releases. However, if you upgrade to 3.x manually then Renovate will reenable minor and patch updates automatically.

If this PR was closed by mistake or you changed your mind, you can simply rename this PR and you will soon get a fresh replacement PR opened.