ld-cv

Frontend convention checker for React/Vue/TypeScript projects with 33 built-in rules.

Installation

# Global installation
npm install -g ld-cv

# Or as dev dependency
npm install --save-dev ld-cv

Usage

# Check a directory
ld-cv check ./src

# Check with custom config
ld-cv check ./src --config convention-checker.yaml

# Output as JSON
ld-cv check ./src --format json --output report.json

# Run specific rules only
ld-cv check ./src --rules no-any,no-magic-string

# List all available rules
ld-cv list-rules

# Generate default config file
ld-cv init

Rules (33 total)

Type Safety (4)

• no-any - Disallows any type
• no-null-undefined-unsafe - Ensure safe null/undefined handling
• async-return-type - Async functions must have explicit return types
• reusable-types - Types should be reusable

Magic Values (3)

• no-magic-string - Disallows magic strings
• no-magic-number - Avoid magic numbers
• no-hardcoded-api-path - API paths should not be hardcoded

Naming Convention (3)

• naming-convention - Functions should start with verbs
• boolean-prefix - Booleans should have is/has/can prefix
• domain-language - Use domain-specific names

Component Structure (5)

• max-component-lines - Components should not exceed 150 lines
• no-business-logic-in-component - No business logic in components
• single-responsibility - Components should have single responsibility
• pure-ui-component - UI components should be pure
• split-conditional-render - Split 3+ conditional renders

React Patterns (9)

• no-unnecessary-useeffect - Avoid unnecessary useEffect
• minimal-state - Avoid storing derivable values in state
• no-conditional-hook - Hooks must not be called conditionally
• useeffect-cleanup - useEffect should have cleanup
• no-array-index-key - Avoid array index as key
• no-inline-handler - No inline event handlers
• no-props-drilling - Detect props drilling
• required-loading-error-empty - Handle loading/error/empty states
• use-form-library - Use form library for complex forms

Async/API (3)

• no-nested-async - Avoid nested async
• api-response-mapping - Map API responses to domain types
• result-type-error - Prefer Result pattern

Code Quality (6)

• no-deep-optional-chaining - Limit optional chaining depth
• extract-complex-condition - Extract complex conditions
• no-deep-equal - Avoid deep equality checks
• no-new-date-in-component - Avoid new Date() in components
• server-client-time - Distinguish server/client time
• minimal-global-state - Minimize global state

Configuration

Create convention-checker.yaml:

version: "1.0"

frontend:
  enabled: true
  paths:
    include: ["src/**/*.ts", "src/**/*.tsx"]
    exclude: ["**/node_modules/**", "**/*.d.ts"]

  rules:
    no-any:
      enabled: true
      severity: ERROR
    max-component-lines:
      enabled: true
      severity: WARNING
      options:
        max-lines: 150

output:
  format: console
  colors: true
  fail-on-error: true

License

MIT