Skip to content

Developer Guide

Welcome to the noidea developer documentation. This section provides information for contributors and developers who want to understand or extend noidea's functionality.

Project Architecture

noidea is written in Go and organized into several key components:

  • cmd: Command-line interface and entry points
  • internal: Core functionality modules
  • scripts: Git hooks and installation scripts
noidea/
├── cmd/               # Commands implementation
│   ├── root.go        # Base command and CLI setup
│   ├── suggest.go     # Commit suggestion command
│   ├── moai.go        # Feedback command
│   └── ...
├── internal/          # Internal packages
│   ├── config/        # Configuration handling
│   ├── feedback/      # Feedback generation
│   ├── git/           # Git operations
│   ├── history/       # Commit history analysis
│   ├── moai/          # Moai face and local feedback
│   ├── personality/   # AI personality system
│   └── secure/        # Secure API key storage
├── scripts/           # Installation and Git hooks
└── docs/              # Documentation

Key Components

Command Layer

The cmd package uses the Cobra library to implement the CLI commands. Each command is defined in its own file.

Internal Packages

  • config: Handles reading/writing configuration from files and environment
  • feedback: Generates AI-powered feedback through different providers
  • git: Manages Git operations like getting diffs and commit history
  • history: Analyzes commit patterns and statistics
  • moai: Manages Moai faces and local feedback generation
  • personality: Handles the AI personality system and templates
  • secure: Manages secure storage of API keys

Getting Started with Development

  1. Clone the repository: 

    git clone https://github.com/AccursedGalaxy/noidea.git
cd noidea

  2. Install dependencies: 

    go mod download

  3. Build the project: 

    go build

  4. Run tests: 

    go test ./...

Development Workflow

  1. Create a feature branch: 

    git checkout -b feature/my-new-feature

  2. Make your changes and test them: 

    go build && ./noidea <command>

  3. Formatting and Linting: 

    # Format the code (also happens automatically on commit)
make format

# Run linters to check code quality
make script-lint

# Check dependencies
make deps

The project uses Git hooks to automatically format and lint your code when committing: - Pre-commit hook: Automatically runs go mod tidy, formats code, organizes imports, and lints - Pre-push hook: Runs tests before allowing a push to remote

  1. Commit your changes: 
    git add .
git commit -m "Your commit message"
    The pre-commit hook will automatically:
  2. Format code with goimports and gofmt
  3. Organize imports consistently
  4. Run linters to catch common issues

  5. Add formatted files to your commit

  6. Push your changes: 

    git push origin feature/my-new-feature
    The pre-push hook will run tests to ensure nothing breaks

  7. Submit a pull request:

  8. Ensure all tests pass
  9. Update documentation if needed
  10. Follow the code style of the project

Useful Make Commands

# Set up Git hooks (if not already set up)
make setup-hooks

# Format code manually
make format

# Run linters on project files
make script-lint

# Run tests
make test

# Build the project
make build

Documentation

Documentation is built using MkDocs with the Material theme.

To preview the documentation locally:

# Install mkdocs and the material theme
pip install mkdocs mkdocs-material

# Serve the documentation locally
mkdocs serve

More Developer Resources