fix: require optional dependencies conditionally #7549
Merged
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
prettier and webpack are only available in dev environment.
caugner
force-pushed
the
dont-import-optional-deps
branch
from
1febbdf to
a1560f6
Compare
caugner
changed the title
| @@ -107,7 +105,8 @@ export function execGit(args, opts: { cwd?: string } = {}, root = null) { | |||
| export function toPrettyJSON(value) { | |||
| const json = JSON.stringify(value, null, 2) + "\n"; | |||
| try { | |||
| return prettier.format(json, { parser: "json" }); | |||
| // eslint-disable-next-line n/no-unpublished-require | |||
| return require("prettier").format(json, { parser: "json" }); | |||
There was a problem hiding this comment.
Could we use await import("prettier") instead, just to keep everything ESM?
There was a problem hiding this comment.
We could, if we would set module in tsconfig.json, but we haven't yet figured out how to make this work, see #7548 for example.
queengooborg
approved these changes
Nov 10, 2022
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.
Summary
Should fix the failing check when bumping yari in mdn/content mdn/content#22218.
Problem
#7430 changed the way we import dependencies by moving from
requiretoimport, andimportstatements cannot be imported conditionally, because they must appear at the top of the file. However, whenimporting (orrequireing) an optional dependency (e.g. adevDepencency) unconditionally, this will cause an error.Specifically, we
requireprettier and webpack, which are available when developing yari, but not when using yari as part of mdn/content.PS: ESLint actually complains about this via the
n/no-unpublished-importrule, but we don't currently run ESLint on TypeScript until #7454 lands and that PR has that rule disabled.Solution
When using (dev) dependencies, use a conditional
requireinstead ofimport.PS: Migrating to ESM would allow us to use
await import("webpack")instead, but we're not there yet.Screenshots
n/a
How did you test this change?
Relying on tests.