Coding Standards

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

作者 affaan-mef648e01899ba3e8dc6371642deaaf64b4477775无许可证275K 个星标收录于 2026年10月9日更新于 2026年10月9日仓库4天前更新

TypeScript, JavaScript, React ve Node.js geliştirme için evrensel kodlama standartları, en iyi uygulamalar ve kalıplar.

AI 生成的概览

适用于 TypeScript、JavaScript、React 和 Node.js 开发的通用编码标准与最佳实践。

功能
该技能提供一套适用于 TypeScript、JavaScript、React 和 Node.js 开发的编码标准与最佳实践参考。内容涵盖命名规范、不可变性、错误处理、异步模式、类型安全、React 组件与 Hook 结构、REST API 设计、文件组织、注释与 JSDoc、性能技巧、测试规范以及代码坏味道识别。它输出的是指导与示例,而不是文件或脚本。
适用场景
适合在启动新项目或模块、为代码质量与可维护性做代码审查、按规范重构现有代码,或强制统一命名、格式与结构时使用。也适用于配置 lint、格式化或类型检查规则,以及让新贡献者熟悉编码规范。
运行要求
无需任何工具、软件包或凭据;仅为说明性内容,不附带脚本。

Kodlama Standartları ve En İyi Uygulamalar

Tüm projelerde uygulanabilir evrensel kodlama standartları.

Ne Zaman Aktifleştirmelisiniz

  • Yeni bir proje veya modül başlatırken
  • Kod kalitesi ve sürdürülebilirlik için kod incelerken
  • Mevcut kodu kurallara uygun hale getirmek için refactor ederken
  • İsimlendirme, biçimlendirme veya yapısal tutarlılığı zorunlu kılarken
  • Linting, biçimlendirme veya tür kontrolü kuralları ayarlarken
  • Yeni katkıda bulunanları kodlama kurallarına alıştırırken

Kod Kalitesi İlkeleri

1. Önce Okunabilirlik

  • Kod yazılmaktan çok okunur
  • Net değişken ve fonksiyon isimleri
  • Yorumlardan çok kendi kendini belgeleyen kod tercih edilir
  • Tutarlı biçimlendirme

2. KISS (Keep It Simple, Stupid - Basit Tut)

  • Çalışan en basit çözüm
  • Aşırı mühendislikten kaçının
  • Erken optimizasyon yapmayın
  • Anlaşılır kod > akıllıca kod

3. DRY (Don't Repeat Yourself - Kendini Tekrar Etme)

  • Ortak mantığı fonksiyonlara çıkarın
  • Yeniden kullanılabilir bileşenler oluşturun
  • Yardımcı araçları modüller arasında paylaşın
  • Kopyala-yapıştır programlamadan kaçının

4. YAGNI (You Aren't Gonna Need It - İhtiyacın Olmayacak)

  • İhtiyaç duyulmadan özellikler oluşturmayın
  • Spekülatif genellemeden kaçının
  • Karmaşıklığı sadece gerektiğinde ekleyin
  • Basit başlayın, gerektiğinde refactor edin

TypeScript/JavaScript Standartları

Değişken İsimlendirme

typescript
// PASS: İYİ: Açıklayıcı isimlerconst marketSearchQuery = 'election'const isUserAuthenticated = trueconst totalRevenue = 1000
// FAIL: KÖTÜ: Belirsiz isimlerconst q = 'election'const flag = trueconst x = 1000

Fonksiyon İsimlendirme

typescript
// PASS: İYİ: Fiil-isim kalıbıasync function fetchMarketData(marketId: string) { }function calculateSimilarity(a: number[], b: number[]) { }function isValidEmail(email: string): boolean { }
// FAIL: KÖTÜ: Belirsiz veya sadece isimasync function market(id: string) { }function similarity(a, b) { }function email(e) { }

Değişmezlik Kalıbı (KRİTİK)

typescript
// PASS: HER ZAMAN spread operatörü kullanınconst updatedUser = {  ...user,  name: 'New Name'}
const updatedArray = [...items, newItem]
// FAIL: ASLA doğrudan mutasyon yapmayınuser.name = 'New Name'  // KÖTÜitems.push(newItem)     // KÖTÜ

Hata Yönetimi

typescript
// PASS: İYİ: Kapsamlı hata yönetimiasync 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: KÖTÜ: Hata yönetimi yokasync function fetchData(url) {  const response = await fetch(url)  return response.json()}

Async/Await En İyi Uygulamaları

typescript
// PASS: İYİ: Mümkün olduğunda paralel yürütmeconst [users, markets, stats] = await Promise.all([  fetchUsers(),  fetchMarkets(),  fetchStats()])
// FAIL: KÖTÜ: Gereksiz yere sıralıconst users = await fetchUsers()const markets = await fetchMarkets()const stats = await fetchStats()

Tür Güvenliği

typescript
// PASS: İYİ: Doğru tiplerinterface Market {  id: string  name: string  status: 'active' | 'resolved' | 'closed'  created_at: Date}
function getMarket(id: string): Promise<Market> {  // Implementation}
// FAIL: KÖTÜ: 'any' kullanımıfunction getMarket(id: any): Promise<any> {  // Implementation}

React En İyi Uygulamaları

Bileşen Yapısı

typescript
// PASS: İYİ: Tiplerle fonksiyonel bileşeninterface 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: KÖTÜ: Tip yok, belirsiz yapıexport function Button(props) {  return <button onClick={props.onClick}>{props.children}</button>}

Özel Hook'lar

typescript
// PASS: İYİ: Yeniden kullanılabilir özel hookexport 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}
// Kullanımconst debouncedQuery = useDebounce(searchQuery, 500)

State Yönetimi

typescript
// PASS: İYİ: Doğru state güncellemelericonst [count, setCount] = useState(0)
// Önceki state'e dayalı fonksiyonel güncellemesetCount(prev => prev + 1)
// FAIL: KÖTÜ: Doğrudan state referansısetCount(count + 1)  // Async senaryolarda eski olabilir

Koşullu Render

typescript
// PASS: İYİ: Açık koşullu render{isLoading && <Spinner />}{error && <ErrorMessage error={error} />}{data && <DataDisplay data={data} />}
// FAIL: KÖTÜ: Ternary cehennemi{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}

API Tasarım Standartları

REST API Kuralları

GET    /api/markets              # Tüm marketleri listeleGET    /api/markets/:id          # Belirli marketi getirPOST   /api/markets              # Yeni market oluşturPUT    /api/markets/:id          # Marketi güncelle (tam)PATCH  /api/markets/:id          # Marketi güncelle (kısmi)DELETE /api/markets/:id          # Marketi sil
# Filtreleme için query parametreleriGET /api/markets?status=active&limit=10&offset=0

Response Formatı

typescript
// PASS: İYİ: Tutarlı response yapısıinterface ApiResponse<T> {  success: boolean  data?: T  error?: string  meta?: {    total: number    page: number    limit: number  }}
// Başarılı responsereturn NextResponse.json({  success: true,  data: markets,  meta: { total: 100, page: 1, limit: 10 }})
// Hata responsereturn NextResponse.json({  success: false,  error: 'Invalid request'}, { status: 400 })

Input Doğrulama

typescript
import { z } from 'zod'
// PASS: İYİ: Schema doğrulamaconst 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)    // Doğrulanmış veriyle devam et  } catch (error) {    if (error instanceof z.ZodError) {      return NextResponse.json({        success: false,        error: 'Validation failed',        details: error.errors      }, { status: 400 })    }  }}

Dosya Organizasyonu

Proje Yapısı

src/├── app/                    # Next.js App Router│   ├── api/               # API routes│   ├── markets/           # Market sayfaları│   └── (auth)/           # Auth sayfaları (route groups)├── components/            # React bileşenleri│   ├── ui/               # Genel UI bileşenleri│   ├── forms/            # Form bileşenleri│   └── layouts/          # Layout bileşenleri├── hooks/                # Özel React hooks├── lib/                  # Yardımcı araçlar ve konfigürasyonlar│   ├── api/             # API istemcileri│   ├── utils/           # Yardımcı fonksiyonlar│   └── constants/       # Sabitler├── types/                # TypeScript tipleri└── styles/              # Global stiller

Dosya İsimlendirme

components/Button.tsx          # Bileşenler için PascalCasehooks/useAuth.ts              # 'use' öneki ile camelCaselib/formatDate.ts             # Yardımcı araçlar için camelCasetypes/market.types.ts         # .types soneki ile camelCase

Yorumlar ve Dokümantasyon

Ne Zaman Yorum Yapmalı

typescript
// PASS: İYİ: NİÇİN'i açıklayın, NE'yi değil// Kesintiler sırasında API'yi aşırı yüklemekten kaçınmak için exponential backoff kullanconst delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// Büyük dizilerle performans için burada kasıtlı olarak mutasyon kullanılıyoritems.push(newItem)
// FAIL: KÖTÜ: Açık olanı belirtmek// Sayacı 1 artırcount++
// İsmi kullanıcının ismine ayarlaname = user.name

Public API'ler için JSDoc

typescript
/** * Semantik benzerlik kullanarak market arar. * * @param query - Doğal dil arama sorgusu * @param limit - Maksimum sonuç sayısı (varsayılan: 10) * @returns Benzerlik skoruna göre sıralanmış market dizisi * @throws {Error} OpenAI API başarısız olursa veya Redis kullanılamazsa * * @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[]> {  // Implementation}

Performans En İyi Uygulamaları

Memoization

typescript
import { useMemo, useCallback } from 'react'
// PASS: İYİ: Pahalı hesaplamaları memoize etconst sortedMarkets = useMemo(() => {  return markets.sort((a, b) => b.volume - a.volume)}, [markets])
// PASS: İYİ: Callback'leri memoize etconst handleSearch = useCallback((query: string) => {  setSearchQuery(query)}, [])

Lazy Loading

typescript
import { lazy, Suspense } from 'react'
// PASS: İYİ: Ağır bileşenleri lazy yükleconst HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {  return (    <Suspense fallback={<Spinner />}>      <HeavyChart />    </Suspense>  )}

Veritabanı Sorguları

typescript
// PASS: İYİ: Sadece gerekli sütunları seçconst { data } = await supabase  .from('markets')  .select('id, name, status')  .limit(10)
// FAIL: KÖTÜ: Her şeyi seçconst { data } = await supabase  .from('markets')  .select('*')

Test Standartları

Test Yapısı (AAA Kalıbı)

typescript
test('benzerliği doğru hesaplar', () => {  // Arrange (Hazırla)  const vector1 = [1, 0, 0]  const vector2 = [0, 1, 0]
  // Act (İşle)  const similarity = calculateCosineSimilarity(vector1, vector2)
  // Assert (Doğrula)  expect(similarity).toBe(0)})

Test İsimlendirme

typescript
// PASS: İYİ: Açıklayıcı test isimleritest('sorguya uygun market bulunamadığında boş dizi döndürür', () => { })test('OpenAI API anahtarı eksikse hata fırlatır', () => { })test('Redis kullanılamazsa substring aramaya geri döner', () => { })
// FAIL: KÖTÜ: Belirsiz test isimleritest('çalışır', () => { })test('arama testi', () => { })

Kod Kokusu Tespiti

Bu anti-kalıplara dikkat edin:

1. Uzun Fonksiyonlar

typescript
// FAIL: KÖTÜ: 50 satırdan uzun fonksiyonfunction processMarketData() {  // 100 satır kod}
// PASS: İYİ: Küçük fonksiyonlara bölfunction processMarketData() {  const validated = validateData()  const transformed = transformData(validated)  return saveData(transformed)}

2. Derin İç İçe Geçme

typescript
// FAIL: KÖTÜ: 5+ seviye iç içe geçmeif (user) {  if (user.isAdmin) {    if (market) {      if (market.isActive) {        if (hasPermission) {          // Bir şeyler yap        }      }    }  }}
// PASS: İYİ: Erken dönüşlerif (!user) returnif (!user.isAdmin) returnif (!market) returnif (!market.isActive) returnif (!hasPermission) return
// Bir şeyler yap

3. Sihirli Sayılar

typescript
// FAIL: KÖTÜ: Açıklanmamış sayılarif (retryCount > 3) { }setTimeout(callback, 500)
// PASS: İYİ: İsimlendirilmiş sabitlerconst MAX_RETRIES = 3const DEBOUNCE_DELAY_MS = 500
if (retryCount > MAX_RETRIES) { }setTimeout(callback, DEBOUNCE_DELAY_MS)

Unutmayın: Kod kalitesi pazarlık konusu değildir. Açık, sürdürülebilir kod hızlı geliştirme ve güvenli refactoring sağlar.

来源与署名

来源:affaan-m/ECC位于docs/tr/skills/coding-standards提交ef648e0

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架