Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Don't require a name for the root package.json. #9378

Merged
merged 4 commits into from
Nov 5, 2024
+27 −3
Merged

fix: Don't require a name for the root package.json. #9378

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99029e9
fix: Don't require a name for the root package.json.
anthonyshew Nov 4, 2024
48ea42f
test
anthonyshew Nov 4, 2024
fa6867b
WIP
anthonyshew Nov 4, 2024
e83a69b
WIP
anthonyshew Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions crates/turborepo-repository/src/package_graph/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,20 @@ impl PackageGraph {
pub fn validate(&self) -> Result<(), Error> {
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());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

match name {
Some("") => {
return Err(Error::PackageJsonMissingName(package_json_path));
}
None => {
Comment on lines +150 to +153
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason we're differentiating between "name": "" vs "name": null?

// 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,
}
Comment on lines 146 to 162
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,
            }
        }

}
graph::validate_graph(&self.graph).map_err(Error::InvalidPackageGraph)?;
Expand Down Expand Up @@ -902,4 +913,17 @@ mod test {
))
);
}

#[tokio::test]
async fn test_does_not_require_name_for_root_package_json() {
let root =
AbsoluteSystemPathBuf::new(if cfg!(windows) { r"C:\repo" } else { "/repo" }).unwrap();
let pkg_graph = PackageGraph::builder(&root, PackageJson::from_value(json!({})).unwrap())
.with_package_discovery(MockDiscovery)
.build()
.await
.unwrap();

assert!(pkg_graph.validate().is_ok());
}
}
Loading