Skip to content

Commit e4378b8

Browse files
committed
docs(readme): remove oopsie in package details section
1 parent d15ab65 commit e4378b8

1 file changed

Lines changed: 0 additions & 33 deletions

File tree

README.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1517,34 +1517,17 @@ Further documentation can be found under [`docs/`][x-repo-docs].
15171517

15181518
### Published Package Details
15191519

1520-
<!-- TODO: choose one of the following and --✄--delete--✄-- the others: -->
1521-
15221520
This is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports
15231521
built by Babel for use in Node.js versions that are not end-of-life. For
15241522
TypeScript users, this package supports both `"Node10"` and `"Node16"` module
15251523
resolution strategies.
15261524

1527-
✄------------✄-----------⏶-⏷-----------✄------------✄
1528-
1529-
This is an [ESM-only package][x-pkg-esm-wine] built by Babel for use in Node.js
1530-
versions that are not end-of-life. For TypeScript users, this package supports
1531-
both `"Node10"` and `"Node16"` module resolution strategies.
1532-
1533-
✄------------✄-----------⏶-⏷-----------✄------------✄
1534-
1535-
This is an [ESM-only package][x-pkg-esm-wine] built by Babel for use in
1536-
browser-like environments. For TypeScript users, this package supports both
1537-
`"Node10"` and `"Node16"` module resolution strategies.
1538-
1539-
<!-- TODO: choose one of the above and --✄--delete--✄-- the others! -->
15401525
<!-- symbiote-template-region-end -->
15411526
<!-- TODO: optional additional details here -->
15421527
<!-- symbiote-template-region-start 7 -->
15431528

15441529
<details><summary>Expand details</summary>
15451530

1546-
<!-- TODO: choose one of the following and --✄--delete--✄-- the others: -->
1547-
15481531
That means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`
15491532
or `await import(...)`) source will load this package from the same entry points
15501533
when using Node. This has several benefits, the foremost being: less code
@@ -1553,22 +1536,6 @@ hazard][x-pkg-dual-package-hazard] entirely, distributables are not
15531536
packed/bundled/uglified, a drastically less complex build process, and CJS
15541537
consumers aren't shafted.
15551538

1556-
✄------------✄-----------⏶-⏷-----------✄------------✄
1557-
1558-
That means ESM source will load this package via `import { ... } from ...` or
1559-
`await import(...)` and CJS source will load this package via dynamic
1560-
`import()`. This has several benefits, the foremost being: less code
1561-
shipped/smaller package size, avoiding [dual package
1562-
hazard][x-pkg-dual-package-hazard] entirely, distributables are not
1563-
packed/bundled/uglified, and a drastically less complex build process.
1564-
1565-
The glaring downside, which may or may not be relevant, is that CJS consumers
1566-
cannot `require()` this package and can only use `import()` in an asynchronous
1567-
context. This means, in effect, CJS consumers may not be able to use this
1568-
package at all.
1569-
1570-
<!-- TODO: choose one of the above and --✄--delete--✄-- the others! -->
1571-
15721539
Each entry point (i.e. `ENTRY`) in [`package.json`'s
15731540
`exports[ENTRY]`][x-repo-package-json] object includes one or more [export
15741541
conditions][x-pkg-exports-conditions]. These entries may or may not include: an

0 commit comments

Comments
 (0)