eslint-plugin-sentinel/README.md

A collection of ESLint rules specifically targeted for roblox-ts.

# eslint-plugin-sentinel

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href] [![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

A collection of ESLint rules specifically targeted for roblox-ts.

## Rules

<!-- Do not manually modify this list. Run: `npm run eslint-docs` -->
<!-- begin auto-generated rules list -->

🔧 Automatically fixable by the
[`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡
Manually fixable by
[editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

| Name                                                                  | Description                                                                 | 🔧  | 💡  |
| :-------------------------------------------------------------------- | :-------------------------------------------------------------------------- | :-- | :-- |
| [explicit-size-check](src/rules/explicit-size-check/documentation.md) | Enforce explicitly comparing the `size` property of a value.                | 🔧  | 💡  |
| [prefer-math-min-max](src/rules/prefer-math-min-max/documentation.md) | Prefer `math.min()` and `math.max()` over ternaries for simple comparisons. | 🔧  |     |

<!-- end auto-generated rules list -->

## License

[MIT](./LICENSE) License ©
[Christopher Buss](https://github.com/christopher-buss)

<!-- Badges -->

[npm-version-src]:
	https://img.shields.io/npm/v/eslint-plugin-sentinel?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/eslint-plugin-sentinel
[npm-downloads-src]:
	https://img.shields.io/npm/dm/eslint-plugin-sentinel?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/eslint-plugin-sentinel
[bundle-src]:
	https://img.shields.io/bundlephobia/minzip/eslint-plugin-sentinel?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=eslint-plugin-sentinel
[license-src]:
	https://img.shields.io/github/license/christopher-buss/eslint-plugin-sentinel.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]:
	https://github.com/christopher-buss/eslint-plugin-sentinel/blob/main/LICENSE
[jsdocs-src]:
	https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/eslint-plugin-sentinel