feat: improve error message of ModuleMapMapper #3733
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
danieleformichelli
force-pushed
the
feature/improve-error-message-modulemepmapper
branch
from
2403b0a to
2d6431d
Compare
pepicrft
approved these changes
Nov 26, 2021
| switch self { | ||
| case let .invalidTargetDependency(sourceProject, sourceTarget, dependentTarget): | ||
| return """ | ||
| Invalid target dependency for target \(sourceTarget) of project at path \(sourceProject.pathString): \ |
There was a problem hiding this comment.
Nitpick:
Target A of the project at path X depends on a target B that can't be found
Do we know why that might be the case? If so, we can add an extra sentence hinting to the users what might be the issue.
| Invalid target dependency for target \(sourceTarget) of project at path \(sourceProject.pathString): \ | ||
| can't find target '\(dependentTarget)' | ||
| """ | ||
| case let .invalidProjectTargetDependency(sourceProject, sourceTarget, dependentProject, dependentTarget): |
There was a problem hiding this comment.
Similar comment here. If we can provide hints on why it happened, I'd add them. Otherwise, we can leave it as it is.
fortmarek
approved these changes
Nov 26, 2021
| /// Error type. | ||
| var type: ErrorType { | ||
| switch self { | ||
| case .invalidTargetDependency, .invalidProjectTargetDependency: return .abort |
There was a problem hiding this comment.
is this misconfiguration on the user side? If it's due to how we handle SPM dependencies from Dependencies.swift, I'd mark this as bug.
There was a problem hiding this comment.
It can be both, so I would go with abort
| @@ -107,16 +138,33 @@ public final class ModuleMapMapper: WorkspaceMapping { | |||
| let dependentTarget: Target | |||
| switch dependency { | |||
| case let .target(name): | |||
| guard let dependentTargetFromName = targetsByName[name] else { | |||
There was a problem hiding this comment.
might be worth making a test for whether the errors are actually thrown?
danieleformichelli
deleted the
feature/improve-error-message-modulemepmapper
branch
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.
In case of an error there, tuist was crashing without providing any error