RV Lint Rules

This repository contains custom ESLint rules for the RV backend project. The purpose of these rules is to enforce coding standards and best practices specific to the project.

Rule: @AuthorizedFor Annotation

The @AuthorizedFor annotation is a custom ESLint rule that ensures any new methods added within a resolver have the @AuthorizedFor annotation. This annotation is used to specify the roles or permissions required to access the method.

Installation

To use these custom ESLint rules in your project, follow these steps:

1. Install rv-lint-rules as a dev dependency by running the following command:

npm install --save-dev rv-lint-rules

2. Configure ESLint in your project by creating or modifying the .eslintrc.json or .eslintrc.js file.

3. Add the following configuration to your ESLint configuration file:

{
  "extends": ["rv-lint-rules"]
}

This configuration extends the rv-lint-rules package, enabling the custom rules in your project.

4. Add the following to the ESLint rules:

{
  "rules": {
    "rv-lint-rules/authorized-for-decorator-required": "error"
  }
}

5. Save the configuration file and run ESLint to enforce the rules in your project.

That's it! You have successfully installed and configured the RV lint rules for your project.