Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

eslint-plugin-isaacscript

IsaacScript15.6kMIT4.0.0TypeScript support: included

An ESLint plugin that contains useful rules.

eslint, plugin, isaacscript, lint, linting, prettier, rules, enum, enums, comment, comments, format, autoformat, complete, sentences

readme

eslint-plugin-isaacscript

Magic Mushroom

eslint-plugin-isaacscript is a collection of ESLint rules for IsaacScript mods. (By default, IsaacScript mods are automatically configured to use these rules.)

Configs

  • recommended - Currently, every rule in this plugin is recommended.

Rules

Each rule has emojis denoting:

  • :white_check_mark: - if it belongs to the recommended configuration
  • :wrench: - if some problems reported by the rule are automatically fixable by the --fix command line option
  • :thought_balloon: - if it requires type information
Name Description :white_check_mark: :wrench: :thought_balloon:
isaacscript/enum-member-number-separation Disallows numbers next to letters in enum members :white_check_mark: |
isaacscript/no-invalid-default-map Disallows invalid constructors for the DefaultMap class :white_check_mark: | :thought_balloon:
isaacscript/no-throw Disallows the usage of "throw" :white_check_mark: |
isaacscript/require-v-registration Require variables named "v" to be registered with the save data manager :white_check_mark: