From d4b58d72ed27a3363963235dd43ba4478b9babe0 Mon Sep 17 00:00:00 2001 From: Mike Donnalley Date: Wed, 5 Jun 2024 08:45:28 -0600 Subject: [PATCH] chore: update esm docs --- docs/esm.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/esm.md b/docs/esm.md index 94d6a7b4..0205882a 100644 --- a/docs/esm.md +++ b/docs/esm.md @@ -18,7 +18,8 @@ Here's a high level overview of ESM/CJS interoperability: ⚠️ Link ESM plugins - - Auto-compilation will **not** work with linked ESM plugins. Instead, oclif will use the plugin's compiled source - this means that you must compile the plugin yourself before executing any of the commands. We plan to support this again once the node ecosystem offers more comprehensive native support for ESM. + - Auto-compilation will **not** work with linked ESM plugins that have `ts-node` as a dev dependency. Instead, oclif will use the plugin's compiled source - this means that you must compile the plugin yourself before executing any of the commands. We plan to support this again once the node ecosystem offers more comprehensive native support for ESM. + - You can, however, replace `ts-node` with `tsx` in your dev dependencies if you'd like to have runtime auto-compilation for linked ESM plugins. ### CJS Root plugin ✅ Install CJS plugins @@ -29,7 +30,8 @@ Here's a high level overview of ESM/CJS interoperability: ⚠️ Link ESM plugins - - Auto-compilation will **not** work with linked ESM plugins. Instead, oclif will use the plugin's compiled source - this means that you must compile the plugin yourself before executing any of the commands. We plan to support this again once the node ecosystem offers more comprehensive native support for ESM. + - Auto-compilation will **not** work with linked ESM plugins that have `ts-node` as a dev dependency. Instead, oclif will use the plugin's compiled source - this means that you must compile the plugin yourself before executing any of the commands. We plan to support this again once the node ecosystem offers more comprehensive native support for ESM. + - You can, however, replace `ts-node` with `tsx` in your dev dependencies if you'd like to have runtime auto-compilation for linked ESM plugins. ## Creating an ESM plugin