@aristid/eslint-plugin

An ESLint plugin with rules for Aristid projects

Get started

Prerequisites

• ESLint
• eslintrc config file

Installation

yarn add -D @aristid/eslint-plugin

Then go to eslintrc config file and add plugin:@aristid/recommended to the extends array

module.exports = {
    root: true,
    env: {browser: true, es2020: true},
    rules: {},
    plugins: [],
    extends: [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended",
        "plugin:@aristid/recommended",
    ],
};

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_to_this_project_from_the_one_using_the_plugin>/@aristid/eslint-plugin