Cinnabar Forge ESLint Plugin

A single set of ESLint rules, configurations and plugins to use across Cinnabar Forge projects.

Getting Started

To use this ESLint plugin in your project, you need to have ESLint installed. If you haven't installed ESLint yet, you can do so by running:

npm i -D eslint @cinnabar-forge/eslint-plugin

Create eslint.config.js with this content:

import cinnabarPlugin from "@cinnabar-forge/eslint-plugin";

export default [
  ...cinnabarPlugin.default.map((config) => ({
    ...config,
    files: ["src/**/*.ts"],
  })),
];

Changelog

We curate a human-readable changelog. You can find it in the CHANGELOG.md file.

License

This project is licensed under the ISC License, see the LICENSE file for details.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.

Installation for developers

git clone git@github.com:cinnabar-forge/eslint-plugin.git cinnabar-forge-eslint-plugin
cd cinnabar-forge-eslint-plugin
npm ci

Authors

• Timur Moziev (@TimurRin)