Skip to main content

Convention Detection

argus analyzes your codebase to discover coding conventions and practices.

Naming Conventions

Files

ConventionExampleLanguages
kebab-caseuser-service.tsJavaScript, TypeScript
snake_caseuser_service.pyPython
PascalCaseUserService.goGo (exported)
camelCaseuserService.tsTypeScript

Variables & Functions

argus detects naming patterns:

## Conventions

- Variables use camelCase
- Constants use SCREAMING_SNAKE_CASE
- React components use PascalCase

Code Style

Formatting

Detected from config files:

  • ESLint configuration
  • Prettier settings
  • EditorConfig
  • Go fmt

Import Organization

argus detects import patterns:

## Import Order

1. Standard library imports
2. Third-party imports
3. Local imports

Testing Conventions

PatternMeaning
*_test.goGo tests colocated
__tests__/Jest test directory
*.spec.tsTypeScript specs
test_*.pypytest tests

Documentation Conventions

argus detects documentation patterns:

  • JSDoc comments
  • Go doc comments
  • Python docstrings
  • TypeDoc annotations

Git Conventions

From commit history:

## Git Conventions

- Commit style: Conventional Commits
- Branch naming: `feat/`, `fix/`, `chore/`
- PR template exists

Error Handling

argus identifies error handling patterns:

PatternLanguage
if err != nilGo
try/catchJavaScript/TypeScript
try/exceptPython
Result<T, E>Rust