fix: Don't require a name for the root package.json. #9378
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
turbo-orchestrator
bot
added
area: docs
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Skipped Deployments
|
turbo-orchestrator
bot
removed
the
area: docs
anthonyshew
commented
Nov 4, 2024
chris-olszewski
approved these changes
Nov 4, 2024
Comment on lines
146
to
162
| for info in self.packages.values() { | ||
| let name = info.package_json.name.as_deref(); | ||
| if matches!(name, None | Some("")) { | ||
| let package_json_path = self.repo_root.resolve(info.package_json_path()); | ||
| return Err(Error::PackageJsonMissingName(package_json_path)); | ||
| let package_json_path = self.repo_root.resolve(info.package_json_path()); | ||
| match name { | ||
| Some("") => { | ||
| return Err(Error::PackageJsonMissingName(package_json_path)); | ||
| } | ||
| None => { | ||
| // We don't need to require a name for the root package.json. | ||
| if package_json_path == self.repo_root.join_component("package.json") { | ||
| continue; | ||
| } | ||
|
|
||
| return Err(Error::PackageJsonMissingName(package_json_path)); | ||
| } | ||
| Some(_) => continue, | ||
| } |
There was a problem hiding this comment.
I think this can be simplified by just checking if the package name is Root at the start
for (package_name, info) in self.packages.iter() {
if matches!(package_name, PackageName::Root) {
continue;
}
let name = info.package_json.name.as_deref();
match name {
Some("") | None => {
let package_json_path = self.repo_root.resolve(info.package_json_path());
return Err(Error::PackageJsonMissingName(package_json_path));
}
Some(_) => continue,
}
}
Comment on lines
+150
to
+153
| Some("") => { | ||
| return Err(Error::PackageJsonMissingName(package_json_path)); | ||
| } | ||
| None => { |
There was a problem hiding this comment.
Is there a reason we're differentiating between "name": "" vs "name": null?
| if matches!(name, None | Some("")) { | ||
| let package_json_path = self.repo_root.resolve(info.package_json_path()); | ||
| return Err(Error::PackageJsonMissingName(package_json_path)); | ||
| let package_json_path = self.repo_root.resolve(info.package_json_path()); |
There was a problem hiding this comment.
If we do want to stick to a path based check, we should just be doing info.package_path() == AnchoredSystemPath::new("").unwrap() to see if the relative path of the package is nothing e.g. it's at the root.
anthonyshew
added a commit
that referenced
this pull request
Nov 5, 2024
### Description Following up on Chris' comment on #9378. I didn't see it before I hit merge because I was on mobile.
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.
Description
There doesn't necessarily need to be a
namefield in the root package.json, since it won't get used for other work throughout the graph.Testing Instructions
I wrote a test and tested against
create-turboby removing thenamefield from the root package.json