@project-one/components

Разработка

1. Устанавливаем npm и node.js
2. npm install
3. npm run storybook запустит live-reload сервер со страницами .stories.tsx файлов в папке /src/stories

Тесты

npm run lint запустит проверку линтером. Испольщуется в том числе при сборке. Важно! При падающих тестах не аппрувить/вливать ПР. В крайних ситуациях:

1. Заглушить место с ошибкой в тестах eslint-disable-next-line {тип ошибки}
2. Покрыть строку тудушкой // TODO: {что нужно сделать}
3. Завести задачу, если проблема решаема

Общие правила и принципы разработки проекта:

• Использовать js-стилизацию (style-components, пропы типа sx у MUI) компонентов, вместо файлов стилей
• Отказаться от ипользования react-router-dom и Browser-only API для корректной работы библиотеки в SSR проектах (можно прокинуть/подтянуть из ComponentsProvider)
• При разработке компонента все внутренние стилизованные элементы должны содержать className, прокидываемый из пропсов через classes (как в MUI). Если элемент - кореневой элемент компонента, его классы в пропсах именуются className и classes.root
• Стараться избегать стилизации через вложенные className в пользу покрытия js-стилями элементов
• Явно прописывать типы экспортируемых сущностей, включая возвращаемые типы функций. Не полагаться на вычесленные типы (они могут меняться без оповещения)