# Raycast ESLint Plugin

Raycast provides a plugin designed to help you follow best practices as you build extensions.

Find more on [developers.raycast.com](https://developers.raycast.com/information/tools/eslint).

## Rules

You'll find below a summary of all the rules included in our ESLint plugin.

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

⚠️ Configurations set to warn in.\
✅ Set in the `recommended` configuration.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                                                                           | Description                                                                                     | ⚠️ | 🔧 |
| :----------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :- | :- |
| [no-ambiguous-platform-shortcut](docs/rules/no-ambiguous-platform-shortcut.md) | Warn when a shortcut is ambiguous in cross-platform extensions.                                 | ✅  |    |
| [no-reserved-shortcut](docs/rules/no-reserved-shortcut.md)                     | Warn when a shortcut prop defines a reserved shortcut that Raycast uses.                        | ✅  |    |
| [prefer-common-shortcut](docs/rules/prefer-common-shortcut.md)                 | Warn when a shortcut matches a common one; prefer Keyboard.Shortcut.Common.* from @raycast/api. | ✅  | 🔧 |
| [prefer-ellipsis](docs/rules/prefer-ellipsis.md)                               | Prefer Ellipsis Character                                                                       | ✅  | 🔧 |
| [prefer-placeholders](docs/rules/prefer-placeholders.md)                       | Prefer Placeholders for Text Fields                                                             |    |    |
| [prefer-title-case](docs/rules/prefer-title-case.md)                           | Prefer Title Case                                                                               | ✅  | 🔧 |

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