mirror of
https://github.com/hydralauncher/hydra.git
synced 2026-01-11 13:56:16 +00:00
38 lines
1.5 KiB
Plaintext
38 lines
1.5 KiB
Plaintext
# Hydra Project Rules
|
|
|
|
## Logging
|
|
|
|
- **Always use `logger` instead of `console` for logging** in both main and renderer processes
|
|
- In main process: `import { logger } from "@main/services";`
|
|
- In renderer process: `import { logger } from "@renderer/logger";`
|
|
- Replace all instances of:
|
|
- `console.log()` → `logger.log()`
|
|
- `console.error()` → `logger.error()`
|
|
- `console.warn()` → `logger.warn()`
|
|
- `console.info()` → `logger.info()`
|
|
- `console.debug()` → `logger.debug()`
|
|
- Do not use `console` for any logging purposes
|
|
|
|
## Internationalization (i18n)
|
|
|
|
- All user-facing strings must be translated using i18next
|
|
- Use the `useTranslation` hook in React components: `const { t } = useTranslation("namespace");`
|
|
- Add new translation keys to `src/locales/en/translation.json`
|
|
- Never hardcode English strings in the UI code
|
|
- Placeholder text in form fields must also be translated
|
|
|
|
## Code Style
|
|
|
|
- Use ESLint and Prettier for code formatting
|
|
- Follow TypeScript strict mode conventions
|
|
- Use async/await instead of promises when possible
|
|
- Prefer named exports over default exports for utilities and services
|
|
|
|
## Comments
|
|
|
|
- Keep comments concise and purposeful; avoid verbose explanations.
|
|
- Focus on the "why" or non-obvious context, not restating the code.
|
|
- Prefer self-explanatory naming and structure over excessive comments.
|
|
- Do not comment every line or obvious behavior; remove stale comments.
|
|
- Use docblocks only where they add value (public APIs, complex logic).
|