Package Exports
- eslint-plugin-isaacscript
- eslint-plugin-isaacscript/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-isaacscript) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
eslint-plugin-isaacscript
eslint-plugin-isaacscript is a collection of ESLint rules that can help make your JavaScript/TypeScript code more safe.
This plugin is named after (and used in) the IsaacScript framework. But you don't have to know anything about IsaacScript to use it - you can use this plugin with any JavaScript/TypeScript project.
If you want to get off the ground and running with ESLint + TypeScript in a new project, then you should check out the isaacscript-lint meta-package.
This project is written in TypeScript.
Install / Usage
npm install --save-dev eslint eslint-plugin-isaacscript- Add
"plugin:isaacscript/recommended"to theextendssection of your.eslintrc.jsfile. (This will automatically add the plugin and add all of the recommended rules.)- Alternatively, if you want to only enable some specific rules, then add
"isaacscript"to thepluginssection of your.eslintrc.jsfile, and then add the specific rules that you want in therulessection.
- Alternatively, if you want to only enable some specific rules, then add
Configs
recommended- Enables just the recommended rules.all- Enables all the rules.
Rules
Each rule has emojis denoting:
- ✅ - if it belongs to the
recommendedconfiguration - 🔧 - if some problems reported by the rule are automatically fixable by the
--fixcommand line option - 💭 - if it requires type information
| Name | Description | ✅ | 🔧 | 💭 |
|---|---|---|---|---|
isaacscript/eqeqeq-fix |
Requires the use of === and !== (and automatically fixes) |
✅ | ||
isaacscript/no-let-any |
Disallows declaring variables with let that do not have a type | ✅ | 💭 | |
isaacscript/no-object-any |
Disallows declaring objects and arrays that do not have a type. | ✅ | 💭 | |
isaacscript/no-template-curly-in-string-fix |
Disallows template literal placeholder syntax in regular strings (and automatically fixes) | ✅ |