Codestyle

Пакет содержит наборы конфигураций для eslint, prettier.

• Важно: пакет сырой, будет часто меняться
• Важно: поддерживается только flat конфигурация

Установка

Важно: необходимо иметь доступ к внутреннему gitlab npm-registry.

npm i @own/3ddd-codestyle --save-dev

Конфигурации

На данным момент для каждой цели есть единственный standard конфиг для всего

Eslint

• js/standard - стандартный конфиг для js проектов
• ts/standard - конфиг для ts проектов
• react/standard - конфиг для react проектов
• stylistic/standard - конфиг для стилистических правил (общий)

Prettier

Важно: работа prettier+stylistic не тестировалась, возможны проблемы

• standard - стандартный конфиг для prettier

Примеры использования

ts/react + поддержка стилистический правил

// eslint.config.mjs

import codestyle from '@own/3ddd-codestyle';

export default [
  ...codestyle.eslint.ts.standard,
  ...codestyle.eslint.react.standard,
  ...codestyle.eslint.stylistic.standard,
];

prettier

// prettier.config.mjs

import codestyle from '@own/3ddd-codestyle';

export default codestyle.prettier.standard;

Что делать, если не устраивает правило

1. Страдать
2. Переопределить локально правило
3. Сделать issue в gitlab и предложить изменения

Переопределение конфигураций локально крайне не рекомендуется, т.к. оно приводит к разбросу правил и усложняет поддержку.

Переопределять правила локально полезно, если:

• Есть какое-то техническое issue, которое нельзя решить иначе
• Legacy проект (тогда, правда, непонятно зачем его туда подключили)
• Тестирование изменений в рамках проекта для предложения изменения standard конфигурации (т.к. пакет еще сырой, этот пункт сильно актуальный)

Как оформить issue с предложением изменений

In progress...