Skip to content

Commit

Permalink
doc: spell out condition restrictions
Browse files Browse the repository at this point in the history
PR-URL: #55187
Reviewed-By: Matteo Collina <[email protected]>
  • Loading branch information
jkrems authored and aduh95 committed Oct 19, 2024
1 parent 69ee56a commit e15f779
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/api/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -755,6 +755,20 @@ exports, while resolving the existing `"node"`, `"node-addons"`, `"default"`,

Any number of custom conditions can be set with repeat flags.

Typical conditions should only contain alphanumerical characters,
using ":", "-", or "=" as separators if necessary. Anything else may run
into compability issues outside of node.

In node, conditions have very few restrictions, but specifically these include:

1. They must contain at least one character.
2. They cannot start with "." since they may appear in places that also
allow relative paths.
3. They cannot contain "," since they may be parsed as a comma-separated
list by some CLI tools.
4. They cannot be integer property keys like "10" since that can have
unexpected effects on property key ordering for JS objects.

### Community Conditions Definitions

Condition strings other than the `"import"`, `"require"`, `"node"`, `"module-sync"`,
Expand Down

0 comments on commit e15f779

Please sign in to comment.