ESLint plugin for linting rics files.

Installation

npm install eslint-plugin-rics

Usage

Flat Config (ESLint 9+)

// eslint.config.js
import ricsPlugin from "eslint-plugin-rics";

export default [
  {
    files: ["**/*.rics"],
    ...ricsPlugin.configs.recommended,
    plugins: { rics: ricsPlugin },
  },
];

Legacy Config (ESLint 8)

{
  "plugins": ["rics"],
  "overrides": [
    {
      "files": ["*.rics"],
      "extends": ["plugin:rics/recommended"]
    }
  ]
}

Rules

rics/no-compile-errors

Reports rics compilation errors.

{
  rules: {
    "rics/no-compile-errors": "error",
  },
}

rics/no-compile-warnings

Reports rics compilation warnings.

{
  rules: {
    "rics/no-compile-warnings": "warn",
  },
}

rics/max-nesting-depth

Limits nesting depth in rics files.

{
  rules: {
    "rics/max-nesting-depth": ["warn", { max: 4 }],
  },
}

Recommended Config

The recommended configuration enables:

• rics/no-compile-errors: error
• rics/no-compile-warnings: warn

License

MIT

Built by Better Lyrics