Function ParseModuleConfig

core/modules/config.go:18–38

(src []byte)

const EngineVersionLatest string = "latest"

func ParseModuleConfig(src []byte) (*ModuleConfigWithUserFields, error) {
	// before attempting to parse the entire config, just read the
	// engineVersion field, to perform version checks to see if it's even
	// possible
	var meta struct {
		EngineVersion string `json:"engineVersion"`
	}
	if err := json.Unmarshal(src, &meta); err != nil {
		return nil, fmt.Errorf("failed to decode module config: %w", err)
	}
	meta.EngineVersion = engine.NormalizeVersion(meta.EngineVersion)
	if !engine.CheckMaxVersionCompatibility(meta.EngineVersion, engine.BaseVersion(engine.Version)) {
		return nil, fmt.Errorf("module requires dagger %s, but you have %s", meta.EngineVersion, engine.Version)
	}

	var modCfg ModuleConfigWithUserFields
	if err := json.Unmarshal(src, &modCfg); err != nil {
		return nil, fmt.Errorf("failed to decode module config: %w", err)
	}
	return &modCfg, nil
}

// ModuleConfigWithUserFields is the config for a single module as loaded from a dagger.json file.
// Includes additional fields that should only be set by the user.