noctcore-code-quality/interface-prefix-i
noctcore-code-quality/interface-prefix-i
- Package
- code-quality v1.0.0
- Preset
- none opt-in
- Severity
- off
- Autofix
- No
- Suggestions
- No
- Options
- None
- Type info
- Not needed
Interface names must be I + an uppercase letter (IUserProfile). Opinionated — not in recommended.
An I-prefixed interface reads as an interface at a glance and never collides with a value of the same
name. This is a house-style naming convention, not a correctness rule — some teams find the prefix
noisy. It is therefore excluded from the recommended preset; enable it explicitly if your team
wants it.
Enabling it
Section titled “Enabling it”Not part of recommended. Turn it on directly:
'noctcore-code-quality/interface-prefix-i': 'error'What it flags
Section titled “What it flags”A TSInterfaceDeclaration whose name is not I followed by an uppercase letter
(/^I[A-Z]/). Input fails (the letter after I is lowercase); IUserProfile passes.
Report-only: a rename touches every reference, which a single-file fixer cannot do safely.
interface UserProfile { id: string; }interface Input { value: string; }interface IUserProfile { id: string; }declare global { interface Window { electron: unknown; } } // augmentationWhat it does not flag
Section titled “What it does not flag”- Interfaces inside an ambient
declare module/declare globalblock — their names are dictated by the module being augmented (Register,Window). typealiases: onlyinterfacedeclarations are checked.
When not to use it
Section titled “When not to use it”If your codebase does not use the I interface-prefix convention (most don’t) — leave it off.