Comrado Code Standards

Description

This project is a collection of rules, configs, and reusable components for the Comrado team. Namely:

• eslint configuration.
• prettier rules.

And provides ready-made configs for your project:

• base - a unified configuration for all projects. Helps to follow a common style.
• strict - strict rules to improve code quality.

Usage

1. Add the main package to your project:

yarn add @thecomrado/eslint-config-comrado -D

2. Add peer dependencies to your project (you can check them against the peerDependencies of this repository):

yarn add eslint prettier @eslint/js eslint eslint-config-prettier globals eslint-plugin-import eslint-plugin-prettier eslint-plugin-simple-import-sort typescript-eslint eslint-plugin-project-structure -D

3. Add the prettier configuration of the project to your .prettierrc.js:

module.exports = require('@thecomrado/eslint-config-comrado/prettier')

or using JSON format:

{
  "extends": "@thecomrado/eslint-config-comrado/prettier"
}

4. Configure eslint.config.mjs:

import baseConfig from '@thecomrado/eslint-config-comrado'
// You can use strict configs as well
// import strictConfig from '@thecomrado/eslint-config-comrado/configs/strict'

export default [
  ...baseConfig,
  // Your additional rules here
]