From dc6045b9bae367313d00087a2ca4ff343b47e5cc Mon Sep 17 00:00:00 2001
From: Ben Allfree <ben@benallfree.com>
Date: Fri, 5 Apr 2024 23:10:08 -0700
Subject: [PATCH 1/2] wip

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e5c5b68..31068b1 100644
--- a/README.md
+++ b/README.md
@@ -140,9 +140,9 @@ Because [context switching is expensive](https://www.petrikainulainen.net/softwa
 # Plopfile API
 The plopfile api is the collection of methods that are exposed by the `plop` object. Most of the work is done by [`setGenerator`](#setgenerator) but this section documents the other methods that you may also find useful in your plopfile.
 
-## TypeScript Declarations
+## TypeScript Support
 
-`plop` bundles TypeScript declarations.  Whether or not you write your plopfile in TypeScript, many editors will offer code assistance via these declarations.
+Plop bundles TypeScript declarations and supports TypeScript plopfiles via [NodeJS command line imports](https://nodejs.org/api/cli.html#--importmodule). 
 
 ```javascript
 // plopfile.ts
@@ -153,6 +153,35 @@ export default function (plop: NodePlopAPI) {
 };
 ```
 
+Plop can use a native `polopfile.ts` without compiling it ahead of time by using [tsx loaders](https://github.com/privatenumber/tsx?tab=readme-ov-file#nodejs-loader):
+
+```bash
+npm i -D tsx cross-env
+```
+
+**Node.js v20.6 and above**
+
+```json
+// package.json
+"scripts": {
+  "cross-env NODE_OPTIONS='--import tsx' plop --plopfile=plopfile.ts"
+}
+```
+
+**Node.js v20.5.1 and below**
+
+```json
+// package.json
+"scripts": {
+  "cross-env NODE_OPTIONS='--loader tsx' plop --plopfile=plopfile.ts"
+}
+```
+
+
+## JSDoc Support
+
+Whether or not you write your plopfile in TypeScript, many editors will offer code assistance via JSDoc declarations.
+
 ```javascript
 // plopfile.js
 export default function (

From dad313a2afdc5879d378fe50591e9b804c58d8b2 Mon Sep 17 00:00:00 2001
From: Ben Allfree <ben@benallfree.com>
Date: Fri, 5 Apr 2024 23:17:39 -0700
Subject: [PATCH 2/2] wip

---
 README.md | 33 ++++++++++++++++++++-------------
 1 file changed, 20 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 31068b1..1845fda 100644
--- a/README.md
+++ b/README.md
@@ -130,21 +130,13 @@ $ plop component -- --type react
 ### Running a Generator Forcefully
 By default Plop actions keep your files safe by failing when things look fishy. The most obvious example of this is not allowing an [`add`](#add) action to overwrite a file that already exists. Plop actions individually support the `force` property but you can also use the `--force` flag when running Plop from the terminal. Using the `--force` flag will tell every action to run forcefully. With great power...🕷
 
-## Why Generators?
-Because when you create your boilerplate separate from your code, you naturally put more time and thought into it.
-
-Because saving your team (or yourself) 5-15 minutes when creating every route, component, controller, helper, test, view, etc... [really adds up](https://xkcd.com/1205/).
-
-Because [context switching is expensive](https://www.petrikainulainen.net/software-development/processes/the-cost-of-context-switching/) and saving time is not the only [benefit to automating workflows](https://kentcdodds.com/blog/automation)
+### Using TypeScript plopfiles
 
-# Plopfile API
-The plopfile api is the collection of methods that are exposed by the `plop` object. Most of the work is done by [`setGenerator`](#setgenerator) but this section documents the other methods that you may also find useful in your plopfile.
-
-## TypeScript Support
+Plop bundles TypeScript declarations and supports TypeScript plopfiles via [tsx loaders](https://github.com/privatenumber/tsx?tab=readme-ov-file#nodejs-loader), a feature of [NodeJS command line imports](https://nodejs.org/api/cli.html#--importmodule). 
 
-Plop bundles TypeScript declarations and supports TypeScript plopfiles via [NodeJS command line imports](https://nodejs.org/api/cli.html#--importmodule). 
+First, make a TypesScript plopfile:
 
-```javascript
+```ts
 // plopfile.ts
 import {NodePlopAPI} from 'plop';
 
@@ -153,12 +145,14 @@ export default function (plop: NodePlopAPI) {
 };
 ```
 
-Plop can use a native `polopfile.ts` without compiling it ahead of time by using [tsx loaders](https://github.com/privatenumber/tsx?tab=readme-ov-file#nodejs-loader):
+Next, install [tsx](https://github.com/privatenumber/tsx) and optionally [cross-env](https://www.npmjs.com/package/cross-env):
 
 ```bash
 npm i -D tsx cross-env
 ```
 
+Finally, use `NODE_OPTIONS` to activate the tsx loader. Now Plop can import your `plopfile.ts`:
+
 **Node.js v20.6 and above**
 
 ```json
@@ -177,6 +171,19 @@ npm i -D tsx cross-env
 }
 ```
 
+## Why Generators?
+Because when you create your boilerplate separate from your code, you naturally put more time and thought into it.
+
+Because saving your team (or yourself) 5-15 minutes when creating every route, component, controller, helper, test, view, etc... [really adds up](https://xkcd.com/1205/).
+
+Because [context switching is expensive](https://www.petrikainulainen.net/software-development/processes/the-cost-of-context-switching/) and saving time is not the only [benefit to automating workflows](https://kentcdodds.com/blog/automation)
+
+# Plopfile API
+The plopfile api is the collection of methods that are exposed by the `plop` object. Most of the work is done by [`setGenerator`](#setgenerator) but this section documents the other methods that you may also find useful in your plopfile.
+
+## TypeScript Support
+
+Plop bundles TypeScript declarations. See [using TypeScript plopfiles](#using-typescript-plopfiles) for more details.
 
 ## JSDoc Support