这是indexloc提供的服务，不要输入任何密码
Skip to content

Add engines.turbo Validation #1361

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

Closed
wants to merge 1 commit into from
Closed

Add engines.turbo Validation #1361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions cli/cmd/turbo/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ func main() {
os.Exit(1)
}

if cf != nil {
err = config.CheckTurboVersionCompatibility(turboVersion, cf)
if err != nil {
ui.Error(fmt.Sprintf("%s %s", uiPkg.ERROR_PREFIX, color.RedString(err.Error())))
os.Exit(1)
}
}

var logger hclog.Logger
if cf != nil {
logger = cf.Logger
Expand Down
36 changes: 36 additions & 0 deletions cli/internal/config/version_compatibility.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package config

import (
"fmt"

"github.com/Masterminds/semver"
"github.com/vercel/turborepo/cli/internal/fs"
)

// CheckTurboVersionCompatibility makes sure that the Turbo version is compatible with the configuration
func CheckTurboVersionCompatibility(turboVersion string, c *Config) error {
v, err := semver.NewVersion(turboVersion)
if err != nil {
panic(err)
}
err = checkPackageTurboEngineConstraint(v, c.RootPackageJSON)
if err != nil {
return err
}
return nil
}

func checkPackageTurboEngineConstraint(turboVersion *semver.Version, packageJSON *fs.PackageJSON) error {
// The lack of an engine constraint means there's nothing to validate and isn't an error.
if packageJSON == nil || packageJSON.Engines["turbo"] == "" {
return nil
}
c, err := semver.NewConstraint(packageJSON.Engines["turbo"])
if err != nil {
return fmt.Errorf("package.json: the 'engines.turbo' constraint is not valid")
}
if !c.Check(turboVersion) {
return fmt.Errorf("package.json: version '%v' of Turbo does not meet the '%v' engine constraint", turboVersion, packageJSON.Engines["turbo"])
}
return nil
}
1 change: 1 addition & 0 deletions cli/internal/fs/package_json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
type PackageJSON struct {
Name string `json:"name,omitempty"`
Version string `json:"version,omitempty"`
Engines map[string]string `json:"engines,omitempty"`
Scripts map[string]string `json:"scripts,omitempty"`
Dependencies map[string]string `json:"dependencies,omitempty"`
DevDependencies map[string]string `json:"devDependencies,omitempty"`
Expand Down