mperrotti / ui-kit

D2iQ UI Kit

D2iQ UI Kit

UI Kit is a collaboration between D2iQ's product design team and engineering team. UI Kit provides tools for engineers to build apps that follow the guidelines defined by the design team.

• Components
• Design tokens
• Icon library
• Design guidelines

Getting started

Install dependencies (Node v8+, NPM 5+)

npm i

Start storybook server locally then visit http://localhost:6006/

npm start

How to setup git hooks

Run the following npm script

npm run setup:git-hooks

Linting
ESLint is used for linting within the project. We suggest installing the ESLint extension in your preferred code editor.

For more detailed information, see CONTRIBUTING.md

New component

To generate a new component run the command

npm run create:component ComponentName

Unit Testing

npm test

Use test:watch if you want the tests to run automatically when a file changes:

npm run test:watch

You can even pass parameters to the test engine (in this case jest), when you, for instance, want to run a single spec, for example, badge:

npm run test -- --watch badge

Writing unit tests
A recommended reading is Better Specs, we put real effort in making sure we follow these guidelines. Some of the most common ones to follow:

• Single Expectation test: Every unit test should verify one behavior.
• Keep your descriptions concise (bellow 40 chars ideally): One easy way to achieve this one is avoiding using "should" (e.g. "it does not use should" instead of "it should not contain should").
• Create the data you need: If you have a more complicated scenario, generate the data that is relevant to that particular case.

For more on this topic, and examples we recommend Better Specs.

import React from "react";
import Badge from '../badge';
import renderer from 'react-test-renderer';

describe('Badge', () => {
  it("match default badge component", () => {
    expect(renderer
    .create(<Badge>default</Badge>)
    .toJSON()).toMatchSnapshot()
  });
});

Testing with Cypress

To make it easier to select DOM nodes of our components, DOM nodes have a data-cy attribute.

data-cy value naming convention

Parent nodes: The value of data-cy for component's parent node is the same as the component name, but camelCased. For example: The parent node for <PrimaryButton> will have data-cy="primaryButton"

Child nodes: If a child node has a data-cy added, there will be a dash between the parent node's name and a string to describe the child node. For example: The footer element of a <DialogModal> will have data-cy="fullscreenModal-footer"

States and variants: If a node has a special "state", data-cy will prepend a string describing that state after a dot. For example:

• <TextInput disabled> will have data-cy="textInput textInput.disabled"
• A <TextInput> with an error will have data-cy="textInput textInput.error"

For more information on writing selectors, see the Cypress guide.

Commits

You should follow conventional commit formatting rules, as they provide a framework to write explicit messages that are easy to comprehend when looking through the project history and enable automatic change log generation.

These Guidelines got written based on AngularJS Git Commit Message Conventions.

<type>[optional scope]: <description>

[optional body]

[optional footer]

Release / Publishing

After your PR gets merged to master, semantic-release will automatically cut a release if one of your commits is of type feat, fix, or perf.

Pre-release Testing in a Host Project

Build:

npm run dist

Copy to existing project:

cp -r dist/ ../project/node_modules/@dcos/ui-kit/