Skip to content

Available Rules

  • ⭐ mark: the rule which is enabled by plugin:@rotki/recommended preset.
  • ✒️ mark: the rule which is fixable by eslint --fix command.
Rule IDDescription
@rotki/consistent-ref-type-annotationEnsures consistent type annotation position for ref, computed assignments⭐✒️
@rotki/max-dependenciesenforce a maximum number of dependencies per file
@rotki/no-deprecated-classesdisallow the usage of vuetify css classes since they are replaced with tailwindcss⭐✒️
@rotki/no-deprecated-componentsRemoves deprecated classes that do not exist anymore⭐✒️
@rotki/no-deprecated-propsReplaces deprecated props with their replacements⭐✒️
@rotki/no-dot-ts-importsChecks and replaces .ts extension in import statements.⭐✒️
@rotki/no-interpolated-i18n-keydisallow message keys built by interpolating a template literal at the call site
@rotki/no-legacy-library-importReports and replaces imports of @rotki/ui-library-compat with @rotki/ui-library⭐✒️
@rotki/no-redundant-flex-rowdisallow redundant flex-row since flex already defaults to the row direction⭐✒️
@rotki/no-shared-piniadisallow a Pinia instance shared across tests via describe-body or module scope
@rotki/no-unused-i18n-keysdisallow unused i18n keys in locale files⭐✒️

strict

Rule IDDescription
@rotki/composable-no-default-exportForbid default exports in files containing composables
@rotki/composable-prefer-shallowrefPrefer shallowRef() over ref() for primitive values in composables✒️
@rotki/composable-require-cleanupRequire cleanup hooks when composables use side effects
@rotki/composable-return-readonlyRequire returned refs from composables to be wrapped with readonly()✒️
@rotki/composable-ssr-safetyRequire browser global access in composables to be SSR-safe
@rotki/no-conditional-empty-object-spreadDisallow object spreads that conditionally spread nothing to omit a property
@rotki/no-unknown-parametersDisallow function parameters annotated unknown outside error handling and type guards

stylistic

Rule IDDescription
@rotki/composable-input-flexibilityPrefer MaybeRefOrGetter over Ref for composable parameters✒️
@rotki/composable-naming-conventionEnforce consistent naming for composable options and return types
@rotki/no-comment-runDisallow consecutive // comment lines
@rotki/no-leading-body-commentDisallow a comment as the first thing in a function body
@rotki/require-jsdoc-on-composable-optionsRequire JSDoc comments on composable options interface properties
@rotki/tsdoc-on-declarationDocument a declaration with TSDoc rather than //