Choose the rules that fit your Vue 3 project, from callbacks and macro types to component contracts, template readability, and setup ordering.
Configure callback style and length, composable parameter shape, and function declarations in supported Vue and standalone scripts.
Organize script conventions
Choose inline, local, or imported macro types, require call-site type names, and format inline macro declarations.
Compose macro rules
Align template ref variables and keys, enforce naming patterns, and prefer inferred template ref types where supported.
Configure ref conventions
Declare required props and slots, constrain supplied prop types and values, and require generic comments for selected components.
Define component contracts
Keep iteration sources and event handlers simple, combine mixed text interpolation, and configure exact blank-line counts between tags.
Refine template conventions
Group setup statements by their Vue roles and choose a sorting style. Automatic movement is limited to declarations proven safe to reorder.
Explore statement ordering
Vue Perfectionist provides rules only, with no built-in presets. Register the plugin in ESLint's flat configuration and enable the checks you need. Each rule documents its file scope, defaults, options, and fix boundaries.
Follow Getting Started for installation and a complete Vue SFC configuration. Then use Configuration for standalone JS/TS files, auto-import recognition, and public option types, or browse the rules overview to choose checks by purpose.
See Contributing for local setup, tests, package builds, and documentation maintenance. Architecture and Design explains source ownership and the analysis and fix contracts behind the rules.