Skip to content

Commit dd9d9f9

Browse files
authored
doc: project status in readme (#80)
1 parent 4641ae5 commit dd9d9f9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ Forked from https://github.com/guybedford/es-module-lexer.
1010

1111
_Comprehensively handles the JS language grammar while remaining small and fast. - ~90ms per MB of JS cold and ~15ms per MB of JS warm, [see benchmarks](#benchmarks) for more info._
1212

13+
### Project Status
14+
15+
This project is used in Node.js core for detecting the named exports available when importing a CJS module into ESM, and is maintained for this purpose.
16+
17+
PRs will be accepted and upstreamed for parser bugs, performance improvements or new syntax support only.
18+
19+
_Detection patterns for this project are **frozen**_. This is because adding any new export detection patterns would result in fragmented backwards-compatibility. Specifically, it would be very difficult to figure out why an ES module named export for CommonJS might work in newer Node.js versions but not older versions. This problem would only be discovered downstream of module authors, with the fix for module authors being to then have to understand which patterns in this project provide full backwards-compatibily. Rather, by fully freezing the detected patterns, if it works in any Node.js version it will work in any other. Build tools can also reliably treat the supported syntax for this project as a part of their output target for ensuring syntax support.
20+
1321
### Usage
1422

1523
```

0 commit comments

Comments
 (0)