Coding Standards

affaan-m/ECC/docs/es/skills/coding-standards

作者 affaan-mef648e01899ba3e8dc6371642deaaf64b4477775無授權條款275K 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫4 天前更新

Convenciones de codificación base entre proyectos para nomenclatura, legibilidad, inmutabilidad y revisión de calidad de código. Usar skills de frontend o backend para patrones específicos de frameworks.

AI 產生的概覽

跨專案的基礎編碼規範,涵蓋命名、可讀性、不可變性與程式碼品質審查。

功能
提供與特定專案無關的共用編碼規範,包括命名、可讀性、KISS、DRY 與 YAGNI 原則、預設不可變性、錯誤處理、非同步模式、型別安全、API 設計、檔案組織、註解、效能與測試慣例。每條規則都附有標示為正確或錯誤的 TypeScript/JavaScript 與 React 範例,並列出需要留意的程式碼壞味道。此技能僅提供指引,框架相關內容交由其他技能處理。
適用情境
適用於啟動新專案或新模組、審查程式碼品質與可維護性、依規範重構既有程式碼、統一命名格式與結構,或設定 lint、格式化與型別檢查規則時。
執行需求
不需要任何工具、套件或憑證;此技能僅包含說明,不附帶指令碼。

Estándares de Codificación y Buenas Prácticas

Convenciones de codificación base aplicables en todos los proyectos.

Este skill es el suelo compartido, no el manual detallado de frameworks.

  • Usar frontend-patterns para React, estado, formularios, renderizado y arquitectura UI.
  • Usar backend-patterns o api-design para capas de repositorio/servicio, diseño de endpoints, validación y aspectos específicos del servidor.
  • Usar rules/common/coding-style.md cuando necesites la capa de reglas reutilizables más corta en lugar de un recorrido completo del skill.

Cuándo Activar

  • Iniciar un nuevo proyecto o módulo
  • Revisar código para calidad y mantenibilidad
  • Refactorizar código existente para seguir convenciones
  • Hacer cumplir consistencia en nomenclatura, formato o estructura
  • Configurar reglas de linting, formato o verificación de tipos
  • Incorporar nuevos colaboradores a las convenciones de codificación

Límites de Alcance

Activar este skill para:

  • nomenclatura descriptiva
  • valores predeterminados de inmutabilidad
  • legibilidad, KISS, DRY y aplicación de YAGNI
  • expectativas de manejo de errores y revisión de code smells

No usar este skill como fuente principal para:

  • Composición, hooks o patrones de renderizado de React
  • Arquitectura backend, diseño de API o capas de base de datos
  • Orientación específica de frameworks cuando ya existe un skill ECC más específico

Principios de Calidad de Código

1. Legibilidad Primero

  • El código se lee más de lo que se escribe
  • Nombres claros para variables y funciones
  • Código auto-documentado preferido sobre comentarios
  • Formato consistente

2. KISS (Keep It Simple, Stupid)

  • La solución más simple que funcione
  • Evitar sobreingeniería
  • Sin optimización prematura
  • Fácil de entender > código inteligente

3. DRY (Don't Repeat Yourself)

  • Extraer lógica común en funciones
  • Crear componentes reutilizables
  • Compartir utilidades entre módulos
  • Evitar programación por copiar y pegar

4. YAGNI (You Aren't Gonna Need It)

  • No construir features antes de que sean necesarias
  • Evitar generalidad especulativa
  • Agregar complejidad solo cuando sea requerido
  • Empezar simple, refactorizar cuando sea necesario

Estándares TypeScript/JavaScript

Nomenclatura de Variables

typescript
// PASS: BIEN: Nombres descriptivosconst marketSearchQuery = 'election'const isUserAuthenticated = trueconst totalRevenue = 1000
// FAIL: MAL: Nombres poco clarosconst q = 'election'const flag = trueconst x = 1000

Nomenclatura de Funciones

typescript
// PASS: BIEN: Patrón verbo-sustantivoasync function fetchMarketData(marketId: string) { }function calculateSimilarity(a: number[], b: number[]) { }function isValidEmail(email: string): boolean { }
// FAIL: MAL: Poco claro o solo sustantivoasync function market(id: string) { }function similarity(a, b) { }function email(e) { }

Patrón de Inmutabilidad (CRÍTICO)

typescript
// PASS: SIEMPRE usar el operador spreadconst updatedUser = {  ...user,  name: 'New Name'}
const updatedArray = [...items, newItem]
// FAIL: NUNCA mutar directamenteuser.name = 'New Name'  // MALitems.push(newItem)     // MAL

Manejo de Errores

typescript
// PASS: BIEN: Manejo de errores comprensivoasync function fetchData(url: string) {  try {    const response = await fetch(url)
    if (!response.ok) {      throw new Error(`HTTP ${response.status}: ${response.statusText}`)    }
    return await response.json()  } catch (error) {    console.error('Fetch failed:', error)    throw new Error('Failed to fetch data')  }}
// FAIL: MAL: Sin manejo de erroresasync function fetchData(url) {  const response = await fetch(url)  return response.json()}

Buenas Prácticas de Async/Await

typescript
// PASS: BIEN: Ejecución paralela cuando sea posibleconst [users, markets, stats] = await Promise.all([  fetchUsers(),  fetchMarkets(),  fetchStats()])
// FAIL: MAL: Secuencial cuando no es necesarioconst users = await fetchUsers()const markets = await fetchMarkets()const stats = await fetchStats()

Seguridad de Tipos

typescript
// PASS: BIEN: Tipos apropiadosinterface Market {  id: string  name: string  status: 'active' | 'resolved' | 'closed'  created_at: Date}
function getMarket(id: string): Promise<Market> {  // Implementación}
// FAIL: MAL: Usar 'any'function getMarket(id: any): Promise<any> {  // Implementación}

Buenas Prácticas de React

Estructura de Componentes

typescript
// PASS: BIEN: Componente funcional con tiposinterface ButtonProps {  children: React.ReactNode  onClick: () => void  disabled?: boolean  variant?: 'primary' | 'secondary'}
export function Button({  children,  onClick,  disabled = false,  variant = 'primary'}: ButtonProps) {  return (    <button      onClick={onClick}      disabled={disabled}      className={`btn btn-${variant}`}    >      {children}    </button>  )}
// FAIL: MAL: Sin tipos, estructura poco claraexport function Button(props) {  return <button onClick={props.onClick}>{props.children}</button>}

Custom Hooks

typescript
// PASS: BIEN: Custom hook reutilizableexport function useDebounce<T>(value: T, delay: number): T {  const [debouncedValue, setDebouncedValue] = useState<T>(value)
  useEffect(() => {    const handler = setTimeout(() => {      setDebouncedValue(value)    }, delay)
    return () => clearTimeout(handler)  }, [value, delay])
  return debouncedValue}
// Usoconst debouncedQuery = useDebounce(searchQuery, 500)

Gestión de Estado

typescript
// PASS: BIEN: Actualizaciones de estado correctasconst [count, setCount] = useState(0)
// Actualización funcional para estado basado en el estado previosetCount(prev => prev + 1)
// FAIL: MAL: Referencia de estado directasetCount(count + 1)  // Puede estar obsoleta en escenarios async

Renderizado Condicional

typescript
// PASS: BIEN: Renderizado condicional claro{isLoading && <Spinner />}{error && <ErrorMessage error={error} />}{data && <DataDisplay data={data} />}
// FAIL: MAL: Infierno de ternarios{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}

Estándares de Diseño de API

Convenciones de API REST

GET    /api/markets              # Listar todos los marketsGET    /api/markets/:id          # Obtener market específicoPOST   /api/markets              # Crear nuevo marketPUT    /api/markets/:id          # Actualizar market (completo)PATCH  /api/markets/:id          # Actualizar market (parcial)DELETE /api/markets/:id          # Eliminar market
# Parámetros de consulta para filtradoGET /api/markets?status=active&limit=10&offset=0

Formato de Respuesta

typescript
// PASS: BIEN: Estructura de respuesta consistenteinterface ApiResponse<T> {  success: boolean  data?: T  error?: string  meta?: {    total: number    page: number    limit: number  }}
// Respuesta exitosareturn NextResponse.json({  success: true,  data: markets,  meta: { total: 100, page: 1, limit: 10 }})
// Respuesta de errorreturn NextResponse.json({  success: false,  error: 'Invalid request'}, { status: 400 })

Validación de Entrada

typescript
import { z } from 'zod'
// PASS: BIEN: Validación con esquemaconst CreateMarketSchema = z.object({  name: z.string().min(1).max(200),  description: z.string().min(1).max(2000),  endDate: z.string().datetime(),  categories: z.array(z.string()).min(1)})
export async function POST(request: Request) {  const body = await request.json()
  try {    const validated = CreateMarketSchema.parse(body)    // Proceder con datos validados  } catch (error) {    if (error instanceof z.ZodError) {      return NextResponse.json({        success: false,        error: 'Validation failed',        details: error.errors      }, { status: 400 })    }  }}

Organización de Archivos

Estructura del Proyecto

src/├── app/                    # Next.js App Router│   ├── api/               # Rutas API│   ├── markets/           # Páginas de markets│   └── (auth)/           # Páginas de auth (grupos de rutas)├── components/            # Componentes React│   ├── ui/               # Componentes UI genéricos│   ├── forms/            # Componentes de formulario│   └── layouts/          # Componentes de layout├── hooks/                # Custom React hooks├── lib/                  # Utilidades y configuraciones│   ├── api/             # Clientes API│   ├── utils/           # Funciones auxiliares│   └── constants/       # Constantes├── types/                # Tipos TypeScript└── styles/              # Estilos globales

Nomenclatura de Archivos

components/Button.tsx          # PascalCase para componenteshooks/useAuth.ts              # camelCase con prefijo 'use'lib/formatDate.ts             # camelCase para utilidadestypes/market.types.ts         # camelCase con sufijo .types

Comentarios y Documentación

Cuándo Comentar

typescript
// PASS: BIEN: Explicar el POR QUÉ, no el QUÉ// Usar backoff exponencial para evitar sobrecargar la API durante interrupcionesconst delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// Usando mutación deliberadamente aquí por rendimiento con arrays grandesitems.push(newItem)
// FAIL: MAL: Declarar lo obvio// Incrementar contador en 1count++
// Establecer nombre al nombre del usuarioname = user.name

JSDoc para APIs Públicas

typescript
/** * Busca markets usando similitud semántica. * * @param query - Consulta de búsqueda en lenguaje natural * @param limit - Número máximo de resultados (por defecto: 10) * @returns Array de markets ordenados por puntuación de similitud * @throws {Error} Si la API de OpenAI falla o Redis no está disponible * * @example * ```typescript * const results = await searchMarkets('election', 5) * console.log(results[0].name) // "Trump vs Biden" * ``` */export async function searchMarkets(  query: string,  limit: number = 10): Promise<Market[]> {  // Implementación}

Buenas Prácticas de Rendimiento

Memoización

typescript
import { useMemo, useCallback } from 'react'
// PASS: BIEN: Memoizar cómputos costososconst sortedMarkets = useMemo(() => {  return markets.sort((a, b) => b.volume - a.volume)}, [markets])
// PASS: BIEN: Memoizar callbacksconst handleSearch = useCallback((query: string) => {  setSearchQuery(query)}, [])

Carga Diferida

typescript
import { lazy, Suspense } from 'react'
// PASS: BIEN: Cargar componentes pesados de forma diferidaconst HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {  return (    <Suspense fallback={<Spinner />}>      <HeavyChart />    </Suspense>  )}

Consultas de Base de Datos

typescript
// PASS: BIEN: Seleccionar solo las columnas necesariasconst { data } = await supabase  .from('markets')  .select('id, name, status')  .limit(10)
// FAIL: MAL: Seleccionar todoconst { data } = await supabase  .from('markets')  .select('*')

Estándares de Pruebas

Estructura de Pruebas (Patrón AAA)

typescript
test('calculates similarity correctly', () => {  // Arrange (Preparar)  const vector1 = [1, 0, 0]  const vector2 = [0, 1, 0]
  // Act (Actuar)  const similarity = calculateCosineSimilarity(vector1, vector2)
  // Assert (Verificar)  expect(similarity).toBe(0)})

Nomenclatura de Pruebas

typescript
// PASS: BIEN: Nombres de prueba descriptivostest('returns empty array when no markets match query', () => { })test('throws error when OpenAI API key is missing', () => { })test('falls back to substring search when Redis unavailable', () => { })
// FAIL: MAL: Nombres de prueba vagostest('works', () => { })test('test search', () => { })

Detección de Code Smells

Vigilar estos anti-patrones:

1. Funciones Largas

typescript
// FAIL: MAL: Función > 50 líneasfunction processMarketData() {  // 100 líneas de código}
// PASS: BIEN: Dividir en funciones más pequeñasfunction processMarketData() {  const validated = validateData()  const transformed = transformData(validated)  return saveData(transformed)}

2. Anidamiento Profundo

typescript
// FAIL: MAL: 5+ niveles de anidamientoif (user) {  if (user.isAdmin) {    if (market) {      if (market.isActive) {        if (hasPermission) {          // Hacer algo        }      }    }  }}
// PASS: BIEN: Retornos tempranosif (!user) returnif (!user.isAdmin) returnif (!market) returnif (!market.isActive) returnif (!hasPermission) return
// Hacer algo

3. Números Mágicos

typescript
// FAIL: MAL: Números sin explicaciónif (retryCount > 3) { }setTimeout(callback, 500)
// PASS: BIEN: Constantes con nombreconst MAX_RETRIES = 3const DEBOUNCE_DELAY_MS = 500
if (retryCount > MAX_RETRIES) { }setTimeout(callback, DEBOUNCE_DELAY_MS)

Recuerda: La calidad del código no es negociable. El código claro y mantenible permite el desarrollo rápido y la refactorización confiada.

來源與署名

來源:affaan-m/ECC位於docs/es/skills/coding-standards提交ef648e0

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架