Central Design System - Store

Пакет общих компонентов Central Design System от команд B2B-Center на Vue.js

Getting started

У вас должен быть установлен основной пакет CDS

Установка

npm install @central-design-system/store
OR 
yarn add @central-design-system/store

Использование

Импортируйте компонент в ваш проект из установленного пакета

import { componentName } from '@central-design-system/store';

new Vue({
  el: '#app',
  components: { componentName }
})

И используйте как обычный Vue-компонент

<template>
  <component-name></component-name>
</template>  

Contribution

Добавление своего компонента в общий пакет

1. Установка

Запросите доступ к репозиторию на gitlab, после чего склонируйте его

git clone [email protected]:cds/store.git

Переключитесь в ветку по номеру задачи в Jira

git checkout -b issue_CDS-${taskNumber}

2. Создание компонента

Выполните установка зависимостей

npm install

Создайте новый компонент через npm-команду

npm run new:component

В директории src/components появиться папка с новым компонентом

├── src   
    ├── components 
        ├── {{componentName}}           
        │   ├── test             # Директория с тестами
        │   ├── *.scss           # Стили
        │   ├── *.stories.js     # Storybook
        │   ├── *.vue            # Исходники компонента
        │   ├── index.js         # Основной файл

3. Разработка

Запустите dev режим

npm run dev

Напишите код компонента и проверьте его отображение через Storybook

4. Тестирование

Все компоненты рекомендуется покрывать unit-тестами. Подробнее можно прочитать здесь

npm run test

5. Публикация

Добавьте необходимые изменения в область видимости git

git add .

Зафиксируйте изменения через npm-команду. Подробнее

npm run commit

Создайте merge request на gitlab