fix(jsii): improve checks around peerDependencies #2997
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
There are two changes here: - The check that forces package authors to list all `dependencies` in `peerDependencies` is superfluous, and has been removed. This effectively removes the `--fix-peer-dependencies` flag as well. - Add a warning to tell people that when they add a `peerDependency`, they should have a dependency in `devDependencies` as well. Fixes #2994.
packages/jsii/bin/jsii.ts
Outdated
Comment on lines
106
to
120
| const result = argv.watch ? compiler.watch() : compiler.emit(); | ||
| return { projectRoot, emitResult: await result }; | ||
| })() | ||
| .then(({ projectRoot, emitResult }) => { | ||
| for (const diagnostic of emitResult.diagnostics) { | ||
| utils.logDiagnostic(diagnostic, projectRoot); | ||
| } | ||
| if (emitResult.emitSkipped) { | ||
| process.exit(1); | ||
| } | ||
| }) | ||
| .catch((e) => { | ||
| console.error(`Error: ${e.stack}`); | ||
| process.exit(-1); | ||
| }); | ||
| const emitResult = await result; | ||
|
|
||
| const allDiagnostics = [...projectInfoDiagnostics, ...emitResult.diagnostics]; | ||
|
|
||
| for (const diagnostic of allDiagnostics) { | ||
| utils.logDiagnostic(diagnostic, projectRoot); | ||
| } | ||
| if (emitResult.emitSkipped) { | ||
| process.exitCode = 1; | ||
| } | ||
| })().catch((e) => { | ||
| console.error(`Error: ${e.stack}`); | ||
| process.exitCode = -1; | ||
| }); |
There was a problem hiding this comment.
Suggested change
| const result = argv.watch ? compiler.watch() : compiler.emit(); | |
| return { projectRoot, emitResult: await result }; | |
| })() | |
| .then(({ projectRoot, emitResult }) => { | |
| for (const diagnostic of emitResult.diagnostics) { | |
| utils.logDiagnostic(diagnostic, projectRoot); | |
| } | |
| if (emitResult.emitSkipped) { | |
| process.exit(1); | |
| } | |
| }) | |
| .catch((e) => { | |
| console.error(`Error: ${e.stack}`); | |
| process.exit(-1); | |
| }); | |
| const emitResult = await result; | |
| const allDiagnostics = [...projectInfoDiagnostics, ...emitResult.diagnostics]; | |
| for (const diagnostic of allDiagnostics) { | |
| utils.logDiagnostic(diagnostic, projectRoot); | |
| } | |
| if (emitResult.emitSkipped) { | |
| process.exitCode = 1; | |
| } | |
| })().catch((e) => { | |
| console.error(`Error: ${e.stack}`); | |
| process.exitCode = -1; | |
| }); | |
| const result = await (argv.watch ? compiler.watch() : compiler.emit()); | |
| const allDiagnostics = [...projectInfoDiagnostics, ... result.diagnostics]; | |
| for (const diagnostic of allDiagnostics) { | |
| utils.logDiagnostic(diagnostic, projectRoot); | |
| } | |
| if (result.emitSkipped) { | |
| process.exitCode = 1; | |
| } | |
| })().catch((e) => { | |
| console.error(`Error: ${e.stack}`); | |
| process.exitCode = -1; | |
| }); |
| @@ -238,6 +238,20 @@ export class JsiiDiagnostic implements ts.Diagnostic { | |||
| name: 'metadata/missing-peer-dependency', | |||
| }); | |||
|
|
|||
| public static readonly JSII_0006_MISSING_DEV_DEPENDENCY = Code.warning({ | |||
There was a problem hiding this comment.
Maybe drop a comment here stating that for now, it is not possible to increase the severity of this because it's generated before the severity settings are applied?
Co-authored-by: Romain Marcadier <rmuller@amazon.com>
Co-authored-by: Romain Marcadier <rmuller@amazon.com>
Co-authored-by: Romain Marcadier <rmuller@amazon.com>
…nto huijbers/peer-deps-checks
RomainMuller
approved these changes
Sep 22, 2021
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
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.
There are two changes here:
dependenciesinpeerDependenciesis superfluous, and has been removed. Thiseffectively removes the
--fix-peer-dependenciesflag as well.peerDependency,they should have a dependency in
devDependenciesas well.Fixes #2994.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.