// library

Maintainability rules

133 rules

Severity

Bucket

ActiveBucketMaintainability Clear all

Low
Use @since/@deprecated with guidance
When introducing or deprecating public APIs, include @since for introductions and @deprecated with migration notes and links for removals.
maintainabilityreadability-refactor+1
Low
Use <inheritdoc/> judiciously and document exceptions explicitly
Use <inheritdoc/> to inherit docs for overrides/implementations, but explicitly add <exception> and behavior differences when applicable.
maintainabilityreadability-refactor+1
Low
Use Absolute Imports Instead of Relative Imports
Detect relative imports (e.g., `from .module import x`). Relative imports can break if the project structure changes. Recommend using absolute imports (`from package.module import x`) for better clarity and maintainability.
maintainabilitymodule-architecture+2
Low
Use enum constants instead of hardcoded values
When a value comes from a finite set, model it as an enum constant instead of string/int literals.
maintainabilityreadability-refactor+1
Low
Use enums instead of magic strings
Replace string literals that represent finite sets with enums (optionally flagged) or constants.
maintainabilityreadability-refactor+1
Low
Use Metadata API instead of <Head>
Declare SEO metadata via export const metadata or generateMetadata; avoid manual <Head> in App Router.
stack-nextjsstack-react+2
Low
Use named constants for magic values
Replace numeric/string literals with named constants to document meaning.
maintainabilityreadability-refactor
Low
Use object literals for event payloads
When emitting custom events with data using `$emit`, pass an object literal as the payload instead of a raw primitive value, especially if there's a chance more data might be needed later.
api-conventionsmaintainability+1
Low
Use translation keys for user-facing text
Do not hardcode UI strings; use I18n keys with proper scopes.
internationalization-i18nmaintainability
Low
Use Type Annotations for Better Readability
Check if function signatures include type annotations. Type hints improve readability and help catch type-related errors early. Recommend adding type annotations where missing.
maintainabilityreadability-refactor+2
Low
Use Type Annotations for Public APIs
Ensure that functions in public APIs include type annotations. Type annotations improve code clarity and help catch type-related errors early. Recommend adding them where missing.
maintainabilityreadability-refactor+2
Low
Utility Classes Should Not Have Public Constructors
Utility classes are not meant to be instantiated. Mark them as static or provide a private constructor to prevent unintended instantiation.
maintainabilitystyle-conventions
Low
Validate gateway responses and avoid storing PAN substitutes long-term
Accept only short-lived tokens from the gateway (JWT/JWE or opaque) and validate signature/expiry; do not persist tokens beyond business need. Never attempt to reconstruct PAN from tokens. (PCI DSS data minimization)
compliance-pci-dsssecurity-hardening+1

Use @since/@deprecated with guidance

Use <inheritdoc/> judiciously and document exceptions explicitly

Use Absolute Imports Instead of Relative Imports

Use enum constants instead of hardcoded values

Use enums instead of magic strings

Use Metadata API instead of <Head>

Use named constants for magic values

Use object literals for event payloads

Use translation keys for user-facing text

Use Type Annotations for Better Readability

Use Type Annotations for Public APIs

Utility Classes Should Not Have Public Constructors

Validate gateway responses and avoid storing PAN substitutes long-term

Use @since/@deprecated with guidance

Use <inheritdoc/> judiciously and document exceptions explicitly

Use Absolute Imports Instead of Relative Imports

Use enum constants instead of hardcoded values

Use enums instead of magic strings

Use Metadata API instead of <Head>

Use named constants for magic values

Use object literals for event payloads

Use translation keys for user-facing text

Use Type Annotations for Better Readability

Use Type Annotations for Public APIs

Utility Classes Should Not Have Public Constructors

Validate gateway responses and avoid storing PAN substitutes long-term