Installation Guide¶
This guide provides comprehensive installation instructions for aider-lint-fixer across different environments and use cases.
Prerequisites¶
- Python: 3.11 or higher
- Git: Required for aider.chat integration
- Node.js: 16+ (for JavaScript/TypeScript projects)
- npm/yarn: For Node.js package management
Installation Methods¶
1. Standard Installation (Recommended)¶
pip install aider-lint-fixer
2. Installation with Learning Features¶
For enhanced AI-powered error classification:
pip install aider-lint-fixer[learning]
This includes additional dependencies:
- scikit-learn for machine learning models
- pyahocorasick for high-performance pattern matching
3. Development Installation¶
For contributors and developers:
git clone https://github.com/tosin2013/aider-lint-fixer.git
cd aider-lint-fixer
pip install -e .
4. Container Installation¶
Using the provided container setup:
# Build the container
docker build -t aider-lint-fixer .
# Run in container
docker run -v $(pwd):/workspace aider-lint-fixer
Language-Specific Setup¶
Python Projects¶
Install required linters:
pip install flake8 pylint black isort
JavaScript/TypeScript Projects¶
Install ESLint and related tools:
npm install -g eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
Ansible Projects¶
Install ansible-lint:
pip install ansible-lint
Configuration¶
1. Basic Configuration¶
Create a .aider-lint-fixer.json configuration file:
{
"profile": "basic",
"linters": ["flake8", "eslint"],
"auto_fix": true,
"interactive": false
}
2. AI Provider Setup¶
Configure your preferred AI provider for aider.chat:
# OpenAI (default)
export OPENAI_API_KEY="your-api-key"
# Claude
export ANTHROPIC_API_KEY="your-api-key"
# Or use local models
export AIDER_MODEL="ollama/codellama"
Verification¶
Test your installation:
# Check version
aider-lint-fixer --version
# Run basic check
aider-lint-fixer --help
# Test on a sample project
aider-lint-fixer --dry-run ./sample-project
Troubleshooting¶
Common Issues¶
1. Import Errors¶
# If you see "No module named 'aider_lint_fixer'"
pip install --upgrade aider-lint-fixer
2. Permission Errors¶
# Use --user flag for user-local installation
pip install --user aider-lint-fixer
3. Python Version Issues¶
# Check Python version
python --version
# Use specific Python version
python3.11 -m pip install aider-lint-fixer
4. Container Issues¶
# Check if Docker is running
docker --version
# Rebuild container if needed
docker build --no-cache -t aider-lint-fixer .
Getting Help¶
- Check the getting started tutorial for basic usage
- Review CONTRIBUTOR_VERSION_GUIDE.md for development setup
- Report issues on GitHub Issues
Next Steps¶
After installation:
- Read the Node.js Linters Guide for JavaScript/TypeScript projects
- Check the Linter Testing Guide for testing your setup
- Explore the main README for usage examples and features