v7: Rewrite in TypeScript, increased modularity with middleware #127
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KATT
suggested changes
Oct 7, 2020
There was a problem hiding this comment.
A lot of comments in-line. Haven't reviewed the tests.
Main points I have
- Not sold on the middlewares concept unless the return value can be inferred reliably
- I think
process.envshould be optional in the options object - I don't get the point of the second param in makeValidator
src/envalid.ts
Outdated
Comment on lines
28
to
33
| if (spec.choices) { | ||
| if (!Array.isArray(spec.choices)) { | ||
| throw new TypeError(`"choices" must be an array (in spec for "${name}")`) | ||
| } else if (!spec.choices.includes(value)) { | ||
| throw new EnvError(`Value "${value}" not in choices [${spec.choices}]`) | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (spec.choices) { | |
| if (!Array.isArray(spec.choices)) { | |
| throw new TypeError(`"choices" must be an array (in spec for "${name}")`) | |
| } else if (!spec.choices.includes(value)) { | |
| throw new EnvError(`Value "${value}" not in choices [${spec.choices}]`) | |
| } | |
| if (spec.choices && !spec.choices.includes(value)) { | |
| throw new EnvError(`Value "${value}" not in choices [${spec.choices}]`) | |
| } |
I think validating the spec itself (checking it's an array) should be done in the caller and not in validateVar-fn
src/envalid.ts
Outdated
Comment on lines
94
to
98
| try { | ||
| // @ts-ignore FIXME | ||
| if (rawValue === testOnlySymbol) { | ||
| throw new EnvMissingError(formatSpecDescription(spec)) | ||
| } | ||
|
|
||
| if (rawValue === undefined) { | ||
| if (!usingFalsyDefault) { | ||
| throw new EnvMissingError(formatSpecDescription(spec)) | ||
| } | ||
|
|
||
| output[k] = undefined | ||
| } else { | ||
| // @ts-ignore FIXME | ||
| output[k] = validateVar({ name: k, spec, rawValue }) | ||
| } | ||
| } catch (err) { | ||
| if (options.reporter === null) throw err | ||
| errors[k] = err | ||
| } |
There was a problem hiding this comment.
This block is quite hard to follow, could probably be refactored?
SimenB
reviewed
Oct 7, 2020
af
force-pushed
the
v7
branch
3 times, most recently
from
d4bb625 to
9eb3486
Compare
af
force-pushed
the
v7
branch
5 times, most recently
from
5d64527 to
a0a547b
Compare
Typing updates, move Object.freeze() out from middleware Readme update Fix testOnly type error Workaround for testOnly type error
af
changed the title
af
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See this comment for an overview of the changes (and the rest of that thread for context).
Todo