npm package: @reverb-ui/publish-and-convert
Description: Reverb Publish and Convert Design System component kit in React
Author: Rock Content - Team Reverb
Latest version: 0.0.2

# 📦 reverb-package-publish-and-convert

Reverb Publish and Convert component kit in React, Simple, Modular & Accessible UI Components for your React Applications.

Reverb Publish and Convert provides a set of accessible, reusable, and composable React components that make it super easy to create websites and apps.

## 📄 Using Reverb Publish and Convert in a react project

Install the kit package in your react project

```bash
yarn add @reverb-ui/react
yarn add @reverb-ui/publish-and-convert
```

or, with npm:

```bash
npm install @reverb-ui/react
npm install @reverb-ui/publish-and-convert
```

In your entry file (e.g `app.tsx`) use the theme provider

```typescript
# app.tsx

import * as React from "react"
import { ThemeProvider, RockUITheme } from "@reverb-ui/react"

// Use at the root of your app
function App() {
  return (
    <ThemeProvider theme={RockUITheme} resetCSS>
      <App />
    </ThemeProvider>
  )
}
```

Use any component from the library

```typescript
# MyComponent.tsx
import React from 'react'
import { Button } from '@reverb-ui/publish-and-convert'

const MyComponent = () => <Button colorScheme="blue">Foobar</Button>
```

## 🏗️ Getting started in Development

There are two methods for getting started with this repo.

### ➕ Familiar with Git?

```bash
git clone ssh://git@gitlab.rockcontent.com:2222/reverb/package/reverb-package-publish-and-convert.git
```

or with HTTPS:

```bash
git clone https://gitlab.rockcontent.com/reverb/package/reverb-package-publish-and-convert.git
```

then

```bash
cd reverb-package-publish-and-convert && npm install
```

### ➖ Not Familiar with Git?

Click [here](https://gitlab.rockcontent.com/reverb/package/reverb-package-publish-and-convert/-/archive/master/reverb-package-publish-and-convert-master.zip) to download the .zip file.  Extract the contents of the zip file, then open your terminal, change to the project directory, and:

```bash
npm install
```

## 👷 Developing

To start the developing run :

```bash
npm run start
```

This will build a version of your library, run the watcher and also run the Storybook.

To open the Storybook manually open your Browser and navigate to [http://localhost:6006](http://localhost:6006).

Start developing your components in `src/components` folder and update the `src/index.ts` file accordingly.

Always provide an `your-component/stories/your-component.stories.tsx` file, so your component will show up in the Storybook.

You can refer to example `Button` component, learn more about working in development on Reverb Publish and Convert UI, follow [this link](https://wiki.rockcontent.com/share/87b33854-b9a1-4bed-ad2f-e310b1882da4);

## ✨ Creating a new Library

Cleanup the src folder with existing components examples, and add your own components.

### Proposals (Babel)

For smoother development some Babel plugin are included

- [class-properties](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-class-properties)
- [object-rest-spread](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-object-rest-spread)
- [optional-chaining](https://github.com/babel/babel/tree/master/packages/babel-plugin-proposal-optional-chaining)

## 🎨 Styling your components

`SCSS` and `CSS` are supported out of the box just import your styles into your component like you normally would do.

For the use of  `CSS Modules` refere to [rollup-plugin-postcss](https://github.com/egoist/rollup-plugin-postcss)

> But we indicate that you use [styled-components](https://styled-components.com/docs) for styling the components.

## 🧪 Testing

Testing is done with [Jest](https://facebook.github.io/jest/), [@testing-library](https://testing-library.com/docs/);

You can refer to `example.spec.tsx` as an example.

```bash
npm run test
```

or (for testing watch)

```bash
npm run test:watch
```

or (for getting coverage)

```bash
npm run test:coverage
```

## 🚨 Linting

Linting is set up through [ESLint](https://eslint.org/) and configured with  [eslint-config-tsdx](https://www.npmjs.com/package/eslint-config-tsdx);

You can modify linting rules by overriding them in the `.eslintrc` file.

```bash
npm run lint
```

or (for for automatic fixing if possible)

```bash
npm run lint:fix
```

## 🚀 Publishing your library to NPM

To release your library to NPM or your private Registry, make sure you have an active account at [NPM](https://www.npmjs.com/), your `.npmrc` file is correctly setup and the repository url in `package.json` file is set to your repository url, then:

```bash
npm run release
```

Or you only need create a new tag and push the new tag to remote repository, the pipeline will do all the hard work here from compiling a new bundle, creating a new storybook build, publishing the new library version to NPM, and publishing the new storybook build to AWS.

According to the `.terraform` configuration;

Example create new tag:

```bash
git tag -a v1.0.1 -m “Release new component”
```

Now let's check if a tag was created and send it to the remote repository:

```bash
git show v1.0.1 && git push origin v1.0.1
```

> Learn more about our git flow, follow [this link](https://wiki.rockcontent.com/doc/gitflow-workflow-pMwl52On0C#h-flow)

## 🎨 Storybook

For custom layouts, styling, controls, addons and more information about the Storybook please refer to [React Storybook](https://storybook.js.org/docs/react/get-started/introduction) documentation.

## 📝 Scripts

- `npm run start` : Only serves the Storybook.
- `npm run build` : Builds your library  (build can be found in `dist` folder).
- `npm run build:storybook` : Builds the static Storybook in case you want to deploy it.
- `npm run test` : Runs the tests.
- `npm run test:coverage`: Runs the test and shows the coverage.
- `npm run test:watch`: Runs the test and watch the files test.
- `npm run lint` : Runs the linter, TypeScript TypeCheck and StyleLint.
- `npm run lint:fix` : Runs the linter, TypeScript TypeCheck and StyleLint and fixes automatic fixable issues.
- `npm run eslint`: Runs only the JavaScript linter.
- `npm run eslint:fix`: Runs only the JavaScript linter and fixes automatic fixable issues.
- `npm run stylelint`: Runs only the style linter.
- `npm run stylelint:fix`: Runs only the style linter and fixes automatic fixable issues.
- `npm run check-types`: Runs typescript type checker.
- `npm run release` : Publishes your Library on NPM or your private Registry (depending on your config in your `.npmrc` file).

## 🏷️ Resources

### Bundler

- [Rollup.js](https://rollupjs.org/guide/en)

### Code Formatter

- [Prettier](https://prettier.io/)

### React Storybook

- [React Storybook](https://storybook.js.org/docs/react/get-started/introduction)

### Testing Components

- [@testing-library](https://testing-library.com/docs/)
- [Jest](https://facebook.github.io/jest/)

### Code Linting

- [ESLint](https://eslint.org/)
- [eslint-config-tsdx](https://www.npmjs.com/package/eslint-config-tsdx)
- [stylelint-prettier](https://github.com/prettier/stylelint-prettier)
- [stylelint-scss](https://github.com/kristerkari/stylelint-scss)

### Code Compiler

- [Babel 7](https://babeljs.io/)
- [Typescript](https://www.typescriptlang.org/)