Profinansy-ui-lib NPM

Флоу работы

Создать ветку от master
Сделать изменения, обновить версию в package.json, выполнить команду yarn build, запушить в гитлаб и открыть МР в мастер(прикрепляете ссылку на задачу в МР и кидаете его в группу в телеге)
Ревьювер посмотрит на МР, если это апрув, примет МР в main, и выполнит у себя локально команду npm publish

Как смотреть изменения

Надо расшарить локально репу общих компонентов, для этого в терминале в корневой директории проекта profinansy-react-components запустить команду yarn link
В своем проекте, в котором используется эта репа(profinansy, к примеру),надо выполнить команду yarn remove profinansy-ui-lib, затем yarn link profinansy-ui-lib. Для применения изменений выполняйте команду yarn build в репозитории profinansy-react-components. Возможно то, что typescript будет кидать ошибки JSX типа "cannot be used as a JSX component", пока вы не отвяжете локальную привязку
После завершения работы над компонентами, надо отвязать привязку: yarn unlink profinansy-ui-lib, затем yarn add --force profinansy-ui-lib

Как работать с иконками

Все иконки кладем в папку icons в формате svg. Подключать в компонент иконки можно напрямую через import. Они сгенерируются в компоненты автоматически через svgr. Все иконки, используемые на проекте, отображаются в сторибуке. После того, как вы добавили новые иконки в проект, запустите скрипт yarn icons:story. Он автоматически сгенерирует новый .stories файл и добавит все ваши новые иконки.

Темизация

Палитра и общий провайдер, который передает выбранную тему лежит в папке theme. Когда вы подключаете эту библиотеку к своему проекту, то оберните все приложение в провайдер ThemeProvider. Через хук useTheme вы можете получить актуальную тему во всем приложении. Реализация подключения палитры к css в вашем проекте индивидуальна и зависит от библиотек, которые вы используете для кастомизации.

Чтобы компоненты из папки uikit также имели типизацию они должны быть все обренуты в ThemeProvider из styled-components