Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.69 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.69 KB
Raw

Refyne ESLint Plugin

The repository includes custom ESLint rules, written in TypeScript, designed to serve as guardrails. These rules help prevent errors and avoid mistakes when working with NestJS and Mongoose.

File Structure:

  • docs/rules/ for documentation.
  • src/rules/ for rule definitions.
  • tests/ for tests for src/.

Installation

Use npm or a compatible tool to install.

$ npm install --save-dev @refyne/eslint-plugin

Requirements

  • Node.js v18.10.0
  • ESLint

Usage

Modify your .eslintrc.js

{
  plugins: ['@refyne'],
  extends: [
    'plugin:@refyne/recommended',
  ]
}

See also Configuring ESLint.

Rules

💼 Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

Name Description 💼 🔧 💡
inconsistent-mongoose-type-declaration Detects inconsistent mongoose types in schema ✅ 💡
incorrect-mongoose-index-field-name Flags incorrect mongoose index creation on non-existing field ✅
inappropriate-model-injection Restricts model injection in certain files ✅
incorrect-type-annotation-for-injection-model Flags incorrect injection model type in constructor ✅ 💡
incorrect-forward-ref-decorator-usage Flags incorrect usage of forwardRef decorator in constructor ✅ 💡

Development Tools

  • npm test runs tests.