atmos-rules

Cursor Rules for Atmos CLI Project

Project Overview

This is a Golang CLI project using Cobra for command structure and Viper for configuration management. The project maintains high code quality standards through golangci-lint and aims for maximum test coverage. The repository also includes the website source code for https://atmos.tools.

Code Structure

CLI Structure

• Use Cobra's recommended command structure with a root command and subcommands
• Implement each command in a separate file under cmd/ directory
• Use Viper for managing configuration, environment variables, and flags
• Follow the principle of separation of concerns between CLI interface and actual logic

// Preferred command structure
cmd/
  root.go
  command1.go
  command2.go
  ...
pkg/
  feature1/
    feature1.go
    feature1_test.go
  feature2/
    feature2.go
    feature2_test.go

Dependencies

• Manage dependencies with Go modules
• Keep dependencies up to date
• Minimize external dependencies where possible

Testing Requirements

Unit Tests

• Every new feature must include comprehensive unit tests
• Target >80% code coverage for all packages
• Test both happy paths and error conditions
• Use table-driven tests for testing multiple scenarios

// Example of table-driven test
func TestFeature(t *testing.T) {
    testCases := []struct {
        name     string
        input    string
        expected string
        wantErr  bool
    }{
        {
            name:     "valid input",
            input:    "valid",
            expected: "processed",
            wantErr:  false,
        },
        {
            name:     "invalid input",
            input:    "",
            expected: "",
            wantErr:  true,
        },
    }

    for _, tc := range testCases {
        t.Run(tc.name, func(t *testing.T) {
            result, err := Feature(tc.input)
            if tc.wantErr {
                assert.Error(t, err)
            } else {
                assert.NoError(t, err)
                assert.Equal(t, tc.expected, result)
            }
        })
    }
}