Skip to content

Documentation / eslint-plugin-warp-drive

eslint-plugin-warp-drive

Lint rules for helping to ensure best practices and hygiene when using WarpDrive.

💡 Backwards Compatibility

For security and backwards compatibility, this Package is also available as eslint-plugin-ember-data

Rules

  • 🛠️ has Autofix
  • 〽️ has Partial Autofix
  • ✅ Recommended
  • 💜 TypeScript Aware

🏷️ Categories

  • 🐞 Helps prevent buggy code
  • ⚡️ Helps prevent performance issues
  • 🏆 Enforces a best practice
RuleDescription🏷️
no-create-record-rerenderHelps avoid patterns that often lead to excess or broken renders🐞⚡️
no-invalid-relationshipsEnsures the basic part of relationship configuration is setup appropriately🏆
no-legacy-request-patternsRestricts usage of deprecated or discouraged request patterns🏆
no-external-request-patternsRestricts usage of discouraged non-warp-drive request patterns🏆
no-invalid-resource-typesEnsures resource types follow a conventional pattern when used in common APIs🏆✅🛠️
no-invalid-resource-idsEnsures resource ids are strings when used in common APIs🏆✅🛠️
no-legacy-importsEnsures imports use paths specified by the Package Unification RFC🏆✅🛠️

Usage

Recommended Rules are available as a flat config for easy consumption:

ts
// eslint.config.js (flat config)
const WarpDriveRecommended = require('eslint-plugin-warp-drive/recommended');

module.exports = [
  ...WarpDriveRecommended,
];

Variables

Released under the MIT License.