搜索

PythonReactSEOPDF
GitHub Skill

code-style

Enforce code style and formatting preferences. Use when writing or reviewing code to ensure consistent style.

legacy3☆ 3 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

Code Style

Project code style and formatting rules.

Control Flow

Always use brackets for control flow statements. Never single-line without braces.

Wrong
if (condition) return early;

if (x) doSomething();
else doOther();

for (const item of items) process(item);
Right
if (condition) {
  return early;
}

if (x) {
  doSomething();
} else {
  doOther();
}

for (const item of items) {
  process(item);
}

DRY - Don't Repeat Yourself

Always check for existing utilities before creating new ones.

Before Writing New Code
  1. Search hooks/ for existing React hooks
  2. Search utils/ for utility functions
  3. Search atoms/utils/ for Jotai helpers
  4. Check if a service already provides the functionality
  5. Look for similar patterns in the codebase
If Similar Code Exists
  • Extend the existing utility
  • Extract common logic into shared function
  • Don't duplicate - refactor

No Backwards Compatibility

Prefer breaking and remaking over maintaining legacy support.

Do
  • Delete obsolete code entirely
  • Rename things to be correct, update all usages
  • Remove deprecated APIs immediately
  • Refactor aggressively when improving
Don't
  • Keep old function signatures "for compatibility"
  • Add // @deprecated and leave code around
  • Maintain multiple ways to do the same thing
  • Add shims or adapters for old patterns
  • Comment out code "in case we need it"

No Legacy Code

Remove, don't preserve.

Signs of Legacy Code to Remove
  • Commented-out code blocks
  • Functions with _old, _legacy, _deprecated suffixes
  • // TODO: remove after migration
  • Unused exports
  • Dead code paths
  • Backwards-compat shims
When Refactoring
  1. Delete the old implementation
  2. Write the new implementation
  3. Update all call sites
  4. Don't provide migration period

Code Cleanup Rules

  • Delete unused imports immediately
  • Remove empty files
  • Delete unused variables (not just prefix with _)
  • Remove console.log statements
  • Clean up TODO comments by doing them or removing them

Formatting - Use Utilities

Always use @/lib/format instead of manual formatting.

Wrong
{
  value.toLocaleString();
}
{
  new Date(date).toLocaleDateString();
}
{
  `${duration}ms`;
}
{
  (percent * 100).toFixed(1) + "%";
}
Right
import {
  formatInt,
  formatRelativeToNow,
  formatDurationMs,
  formatPercent,
} from "@/lib/format";

{
  formatInt(value);
}
{
  formatRelativeToNow(date);
}
{
  formatDurationMs(duration);
}
{
  formatPercent(percent);
}
Available Formatters
Function Use For
formatInt Large integers with commas
formatCompact Abbreviated numbers (1.2M)
formatPercent Percentages
formatNumber Spell description numbers
formatRelativeToNow Relative time ("2h ago")
formatDate Formatted dates
formatDurationMs Millisecond durations
formatDurationSeconds Second durations

Instructions

When writing or reviewing code:

  1. Check control flow has brackets
  2. Search for existing utilities before creating new ones
  3. Delete obsolete code, don't deprecate
  4. Remove legacy patterns, don't maintain them
  5. Keep codebase lean - when in doubt, delete
  6. Use @/lib/format for all number/date/duration formatting

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-30
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!