Prevent Abbreviations

SuggestionAuto-fixable

small-rules/prevent-abbreviations

Prevent abbreviations.

Rationale

btn, cb, ctx, evt: every abbreviation is one more thing a reader has to expand in their head, and not everyone expands them the same way. Spell the word out. When there’s one clear replacement, the rule can rename it for you everywhere it’s used. When there’s more than one, like e, which could be error or event, it lists them and lets you pick.

Properties aren’t checked by default, since a lot of them belong to Roblox or to a library and you can’t rename them. The rule leaves names imported from packages alone for the same reason. If your team does treat a short name as a word, add it to allowList.

Diagnostic Messages

replace

The {{nameTypeText}} `{{discouragedName}}` should be named `{{replacement}}`. A more descriptive name will do too.

suggestion

Please rename the {{nameTypeText}} `{{discouragedName}}`. Suggested names are: {{replacementsText}}. A more descriptive name will do too.

Configuration

This rule accepts one options object after the severity.

allowListOptional

Names that should be allowed even when they match a discouraged abbreviation.

Type: Record<string, boolean>
Default

Default JSON

{
	"defaultProps": true,
	"devDependencies": true,
	"EmberENV": true,
	"getDerivedStateFromProps": true,
	"getInitialProps": true,
	"getServerSideProps": true,
	"getStaticProps": true,
	"iOS": true,
	"obj": true,
	"propTypes": true,
	"setupFilesAfterEnv": true
}

allowPropertyAccessOptional

Property names that may keep abbreviated member access.

Type: Array<string>
Default

Default JSON

[
	"char"
]

checkDefaultAndNamespaceImportsOptional

Whether default and namespace import local names should be checked.

Type: false | true | "internal"
Default: internal

checkFilenamesOptional

Whether file names should be checked for abbreviations.

Type: boolean
Default: true

checkPropertiesOptional

Whether object, member, and JSX property names should be checked.

Type: boolean
Default: false

checkShorthandImportsOptional

Whether renamed shorthand imports should be checked.

Type: false | true | "internal"
Default: internal

checkShorthandPropertiesOptional

Whether shorthand object property names should be checked.

Type: boolean
Default: true

checkVariablesOptional

Whether variable, function, class, and component names should be checked.

Type: boolean
Default: true

extendDefaultAllowListOptional

Merge configured allowList entries with the default allow list.

Type: boolean
Default: true

extendDefaultReplacementsOptional

Merge configured replacements with the default replacement map.

Type: boolean
Default: true

ignoreOptional

Names or regular expression patterns that should be ignored.

Type: Array<string>
Default

Default JSON

[
	"i18n",
	"l10n"
]

ignoreShorthandsOptional

Shorthand names that should not be reported.

Type: Array<string>
Default

Default JSON

[]

replacementsOptional

Replacement suggestions for discouraged names.

Type: Record<string, false | Record<string, boolean>>
Default

Default JSON

{
	"acc": {
		"accumulator": true
	},
	"arg": {
		"argument": true
	},
	"args": {
		"arguments": true
	},
	"arr": {
		"array": true
	},
	"attr": {
		"attribute": true
	},
	"attrs": {
		"attributes": true
	},
	"btn": {
		"button": true
	},
	"cb": {
		"callback": true
	},
	"char": {
		"character": true
	},
	"conf": {
		"config": true
	},
	"ctx": {
		"context": true
	},
	"cur": {
		"current": true
	},
	"curr": {
		"current": true
	},
	"db": {
		"database": true
	},
	"def": {
		"defer": true,
		"deferred": true,
		"define": true,
		"definition": true
	},
	"dest": {
		"destination": true
	},
	"dev": {
		"development": true
	},
	"dir": {
		"direction": true,
		"directory": true
	},
	"dirs": {
		"directories": true
	},
	"dist": {
		"distance": true
	},
	"doc": {
		"document": true
	},
	"docs": {
		"documentation": true,
		"documents": true
	},
	"dst": {
		"daylightSavingTime": true,
		"destination": true,
		"distribution": true
	},
	"dt": {
		"dateTime": true,
		"deltaTime": true
	},
	"e": {
		"error": true,
		"event": true
	},
	"el": {
		"element": true
	},
	"elem": {
		"element": true
	},
	"elems": {
		"elements": true
	},
	"env": {
		"environment": true
	},
	"envs": {
		"environments": true
	},
	"err": {
		"error": true
	},
	"ev": {
		"event": true
	},
	"evt": {
		"event": true
	},
	"ext": {
		"extension": true
	},
	"exts": {
		"extensions": true
	},
	"fn": {
		"func": true,
		"function": true
	},
	"func": {
		"function": true
	},
	"i": {
		"index": true
	},
	"idx": {
		"index": true
	},
	"impl": {
		"implementation": true
	},
	"j": {
		"index": true
	},
	"len": {
		"length": true
	},
	"lib": {
		"library": true
	},
	"mod": {
		"module": true
	},
	"msg": {
		"message": true
	},
	"num": {
		"number": true
	},
	"obj": {
		"object": true
	},
	"opts": {
		"options": true
	},
	"param": {
		"parameter": true
	},
	"params": {
		"parameters": true
	},
	"pkg": {
		"package": true
	},
	"plr": {
		"player": true
	},
	"prev": {
		"previous": true
	},
	"prod": {
		"production": true
	},
	"prop": {
		"property": true
	},
	"props": {
		"properties": true
	},
	"rel": {
		"related": true,
		"relationship": true,
		"relative": true
	},
	"req": {
		"request": true
	},
	"res": {
		"resource": true,
		"response": true,
		"result": true
	},
	"ret": {
		"returnValue": true
	},
	"retval": {
		"returnValue": true
	},
	"sep": {
		"separator": true
	},
	"src": {
		"source": true
	},
	"stdDev": {
		"standardDeviation": true
	},
	"str": {
		"string": true
	},
	"tbl": {
		"table": true
	},
	"temp": {
		"temporary": true
	},
	"tit": {
		"title": true
	},
	"tmp": {
		"temporary": true
	},
	"util": {
		"utility": true
	},
	"utils": {
		"utilities": true
	},
	"val": {
		"value": true
	},
	"var": {
		"variable": true
	},
	"vars": {
		"variables": true
	},
	"ver": {
		"version": true
	}
}

shorthandsOptional

Shorthand names and the full names they should expand to.

Type: Record<string, string>
Default

Default JSON

{
	"args": "parameters",
	"char": "character",
	"dt": "deltaTime",
	"plr": "player"
}

.oxlintrc.json
oxlint.config.ts

{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/prevent-abbreviations": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  jsPlugins: ["@pobammer-ts/small-rules"],
  rules: {
    "small-rules/prevent-abbreviations": "error",
  },
});

Examples

Abbreviated variable names

const err = new Error();

After auto-fix

const error = new Error();

Expanded variable names

const error = new Error();