@aristid/eslint-plugin

An ESLint plugin with rules for Aristid projects

Get started

Prerequisites

• ESLint v9.x (flat config)
• eslint.config.js file (flat config format)

Installation

yarn add -D @aristid/eslint-plugin

In your eslint.config.js, extend the recommended config:

import { defineConfig } from "eslint/config";
import aristid from "@aristid/eslint-plugin";
import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";

export default defineConfig([
  aristid,
  eslintPluginPrettierRecommended,
  {
    rules: {
      // override rules if needed
    },
  },
]);

How to deploy

Package is deployed to npm registry.

For each new publication don't forget to change the version in package.json and index.js file ( otherwise npm will throw an error, there can only be unique versions).

Login on npm website, then use the following command:

npm publish --access public

How to test locally

You may want to test your new configuration in local, please run this command inside the project using this plugin:

yarn link ../[relative_path]/eslint-plugin

And update in eslint.config.js the plugin import:

import aristid from "../[relative_path]/eslint-plugin/index.js";