doc: spell out condition restrictions #55187
Conversation
|
Review requested:
|
jkrems
force-pushed
the
jk-condition-restrictions
branch
from
d8704aa
to
e2fcec8
Compare
jkrems
force-pushed
the
jk-condition-restrictions
branch
from
e2fcec8
to
f71b086
Compare
doc/api/packages.md
Outdated
| Conditions can be almost any string, including multi-byte characters and | ||
| whitespace. There's only a few restrictions: |
There was a problem hiding this comment.
I would prefer that we do not say this, and instead say something less specific, eg that special characters are permitted in condition names. We should probably ban spaces IMO.
There was a problem hiding this comment.
We could start this with a stronger recommendation (e.g. keep it to /^[a-z0-9:=-]+$/) and only afterwards go into the technical side of what's enforced?
I'm +1 on banning whitespace and also banning quotes and non-ASCII characters. I don't see a clear use case for those but could see many confusing bugs. Conditions usually fail silently, so debugging a "looked like character A but was actually character B" problem seems super annoying.
There was a problem hiding this comment.
Added a more opinionated opening paragraph before delving into the technical restrictions.
jkrems
force-pushed
the
jk-condition-restrictions
branch
from
f71b086
to
5c50184
Compare
jkrems
force-pushed
the
jk-condition-restrictions
branch
from
5c50184
to
b223c49
Compare
I never really thought about what kinds of conditions are allowed and which aren't - and it looks like the answer is mostly "anything goes". This documents the status-quo from a practical perspective from what I can gather.
Some of these restrictions (e.g. "no comma") aren't actively enforced by nodejs but maybe should be in the future.