Function getEngineStepsToTopLevelCodemod

pkg/cli/codemod_engine_steps.go:12–264

getEngineStepsToTopLevelCodemod creates a codemod for moving engine.steps to the top-level steps field

()

// getEngineStepsToTopLevelCodemod creates a codemod for moving engine.steps to the top-level steps field
func getEngineStepsToTopLevelCodemod() Codemod {
	return Codemod{
		ID:           "engine-steps-to-top-level",
		Name:         "Move engine.steps to top-level steps",
		Description:  "Moves the 'steps' field from under 'engine' to the top-level 'steps' field, as 'engine.steps' is no longer supported",
		IntroducedIn: "0.11.0",
		Apply: func(content string, frontmatter map[string]any) (string, bool, error) {
			// Check if engine.steps exists in frontmatter
			engineValue, hasEngine := frontmatter["engine"]
			if !hasEngine {
				return content, false, nil
			}

			engineMap, isMap := engineValue.(map[string]any)
			if !isMap {
				// engine is a string, no steps to move
				return content, false, nil
			}

			if _, hasSteps := engineMap["steps"]; !hasSteps {
				return content, false, nil
			}

			// Determine if existing top-level steps is a sequence
			hasTopLevelSteps := false
			if stepsVal, exists := frontmatter["steps"]; exists {
				if _, isSlice := stepsVal.([]any); isSlice {
					hasTopLevelSteps = true
					engineStepsCodemodLog.Print("Found existing top-level 'steps'")
				} else {
					engineStepsCodemodLog.Print("Top-level 'steps' exists but is not a sequence; treating as absent")
				}
			}

			return applyFrontmatterLineTransform(content, func(frontmatterLines []string) ([]string, bool) {
				// Find engine block and the steps field within it
				engineIndent := ""
				stepsStartIdx := -1
				inEngineBlock := false

				for i, line := range frontmatterLines {
					trimmed := strings.TrimSpace(line)

					if isTopLevelKey(line) && strings.HasPrefix(trimmed, "engine:") {
						engineIndent = getIndentation(line)
						inEngineBlock = true
						engineStepsCodemodLog.Printf("Found 'engine:' block at line %d", i+1)
						continue
					}

					// Check if we've exited the engine block
					if inEngineBlock && len(trimmed) > 0 && !strings.HasPrefix(trimmed, "#") {
						lineIndent := getIndentation(line)
						if len(lineIndent) <= len(engineIndent) {
							inEngineBlock = false
						}
					}