Skip to main content

preset scan

Scan codebase for component patterns and propose presets

Reference

Usage

preset scan [options] [path]

Arguments

  • Name
    path
    Type
    optional · default `src`
    Description

    Directory to scan

Options

  • Name
    -l, --layer \<id>
    Type
    value required
    Description

    Design system layer ID (omit for base layer)

  • Name
    --staged
    Type
    flag
    Description

    Only scan staged files (for pre-commit hooks)

  • Name
    -v, --verbose
    Type
    flag
    Description

    Show detailed output

  • Name
    -c, --component \<name>
    Type
    value required
    Description

    Only scan specific component

  • Name
    -t, --threshold \<n>
    Type
    value required · default `3`
    Description

    Minimum usage count for proposals

  • Name
    -f, --format \<type>
    Type
    value required · default `table`
    Description

    Output format (table, json, markdown)

  • Name
    -o, --output \<file>
    Type
    value required
    Description

    Output file for results

Source

Defined in packages/cli/src/commands/scan.ts.

Was this page helpful?

Last reviewed by @jschuyler