src/common/alerts.ts
interface name must start with a capitalized I Open
Open
interface consolePayload {
- Read upRead up
- Exclude checks
Rule: interface-name
Requires interface names to begin with a capital 'I'
Rationale
Makes it easy to differentiate interfaces from regular classes at a glance.
Notes
- TypeScript Only
Config
One of the following two options must be provided:
-
"always-prefix"
requires interface names to start with an "I" -
"never-prefix"
requires interface names to not have an "I" prefix
Examples
"interface-name": true,always-prefix
"interface-name": true,never-prefix
Schema
{
"type": "string",
"enum": [
"always-prefix",
"never-prefix"
]
}
For more information see this page.
Class name must be in pascal case Open
Open
interface consolePayload {
- Read upRead up
- Exclude checks
Rule: class-name
Enforces PascalCased class and interface names.
Rationale
Makes it easy to differentiate classes from regular variables at a glance.
JavaScript and general programming convention is to refer to classes in PascalCase. It's confusing to use camelCase or other conventions for class names.
Config
Not configurable.
Examples
"class-name": true
For more information see this page.