Function InstructionPath

internal/entities/apps.go:299–333

InstructionPath returns the concrete install path for an instruction identified by app and level. For user-level installs the returned path has ~ expanded via pathutil.Expand. For project-level installs the projectDir must be a non-empty existing directory; the returned path substitutes

(app string, level InstallLevel, projectDir string)

// projectDir must be a non-empty existing directory; the returned path
// substitutes <project> with the project dir.
func InstructionPath(app string, level InstallLevel, projectDir string) (string, error) {
	paths, ok := instructionApps[app]
	if !ok {
		return "", fmt.Errorf("entities: app %q does not support instructions", app)
	}
	switch level {
	case InstallLevelUser:
		if paths.UserPath == "" {
			return "", fmt.Errorf("entities: app %q has no user-level instruction path", app)
		}
		return pathutil.Expand(paths.UserPath), nil
	case InstallLevelProject:
		if paths.ProjectPath == "" {
			return "", fmt.Errorf("entities: app %q has no project-level instruction path", app)
		}
		if projectDir == "" {
			return "", fmt.Errorf("entities: project directory is required for project-level install")
		}
		projectDir = pathutil.Expand(projectDir)
		info, err := os.Stat(projectDir)
		if err != nil {
			return "", fmt.Errorf("entities: project directory %q: %w", projectDir, err)
		}
		if !info.IsDir() {
			return "", fmt.Errorf("entities: %q is not a directory", projectDir)
		}
		absDir, err := filepath.Abs(projectDir)
		if err != nil {
			return "", fmt.Errorf("entities: cannot resolve %q: %w", projectDir, err)
		}
		return strings.Replace(paths.ProjectPath, "<project>", absDir, 1), nil
	default:
		return "", fmt.Errorf("entities: unsupported install level %q", level)
	}
}

// InstallInstruction writes the instruction entity's content to the target
// path determined by app and level.  For user-level installs the path is