Политики кода

КОД = ЧИТАЕМЫЙ + БЕЗОПАСНЫЙ + ПЕРЕИСПОЛЬЗУЕМЫЙ

# Python
black .
ruff check --fix .

# JavaScript/TypeScript
prettier --write .
eslint --fix .

# Bash
shfmt -w *.sh

#!/bin/bash
# .git/hooks/pre-commit
black . || exit 1
ruff check . || exit 1

# 1. Стандартная библиотека
import os
import sys
from typing import List, Dict

# 2. Сторонние библиотеки
import requests
from fastapi import FastAPI

# 3. Локальные модули
from library.connectors import OzonClient
from .models import User

// 1. Внешние библиотеки
import React from 'react';
import { useEffect } from 'react';

// 2. Внутренние модули
import { Button } from '@/components';
import { useAuth } from '@/hooks';

// 3. Локальные
import styles from './styles.module.css';

# ✅ Хорошо
from library.connectors.ozon import OzonClient  # Абсолютный
from .models import User                         # Относительный (та же папка)

# ❌ Плохо
from ../../library/connectors/ozon import OzonClient  # Слишком сложно

library/connectors/ozon/
├── __init__.py          ← Экспорты
├── client.py            ← Главный класс OzonClient
├── models.py            ← Data classes
├── operations.py        ← Операции
└── exceptions.py        ← Исключения

def sync_orders(api_key: str, date_from: str, limit: int = 100) -> Dict[str, int]:
    """Синхронизировать заказы из OZON API.

    Args:
        api_key: API ключ OZON
        date_from: Дата начала в формате YYYY-MM-DD
        limit: Максимальное количество заказов (default: 100)

    Returns:
        Dict с ключами:
            - synced: количество синхронизированных заказов
            - errors: количество ошибок

    Raises:
        ValueError: Если date_from в неверном формате
        APIError: Если API вернул ошибку
    """
    pass

/**
 * Синхронизировать заказы из OZON API.
 *
 * @param apiKey - API ключ OZON
 * @param dateFrom - Дата начала в формате YYYY-MM-DD
 * @param limit - Максимальное количество заказов (default: 100)
 * @returns Объект с количеством синхронизированных заказов
 * @throws {ValueError} Если dateFrom в неверном формате
 */
function syncOrders(apiKey: string, dateFrom: string, limit: number = 100): SyncResult {
    // ...
}

# ❌ Плохо (очевидно)
# Увеличить счётчик на 1
count += 1

# ✅ Хорошо (объясняет почему)
# OZON API возвращает время в UTC+3, конвертируем в UTC
order_time = order_time - timedelta(hours=3)

from typing import List, Dict, Optional, Union

def get_user(user_id: int) -> Optional[User]:
    """Получить пользователя по ID."""
    pass

def process_orders(orders: List[Order]) -> Dict[str, int]:
    """Обработать список заказов."""
    pass

mypy .

interface User {
    id: number;
    name: string;
    email: string;
}

function getUser(userId: number): User | null {
    // ...
}

function processOrders(orders: Order[]): Record<string, number> {
    // ...
}

library/
├── connectors/    ← API клиенты (OZON, 1C, Telegram)
├── functions/     ← Утилиты (парсеры, валидаторы)
└── internal/      ← Хелперы

# ❌ Плохо (дублирование)
def process_order_a(order):
    validate(order)
    save(order)
    notify(order)

def process_order_b(order):
    validate(order)
    save(order)
    notify(order)

# ✅ Хорошо (переиспользование)
def process_order(order):
    validate(order)
    save(order)
    notify(order)

# Python
pytest --cov=. --cov-report=term-missing

# JavaScript
npm test -- --coverage

project/
├── src/
│   └── module.py
└── tests/
    ├── unit/
    │   └── test_module.py
    └── integration/
        └── test_api.py

type(scope): short description

Longer description if needed

Fixes #123

feat(ozon): add order sync method

Implemented sync_orders() method that fetches
orders from OZON API and saves to database.

Fixes #42

main          ← Продакшн
dev           ← Разработка
test          ← Тестирование
feature/*     ← Фичи
fix/*         ← Багфиксы

#!/bin/bash
# .git/hooks/pre-commit

echo "Running pre-commit checks..."

# Форматирование
black . || exit 1
prettier --write . || exit 1

# Линтинг
ruff check . || exit 1
eslint . || exit 1

# Типы
mypy . || exit 1

# Тесты
pytest || exit 1

echo "✅ All checks passed"