README.md

⚛️ Craigponent Library ⚛️

🚀 Getting started

Install package

• Not on NPM yet

👾 Usage

import React, { Component } from 'react'

import MyComponent from 'craigponent-library/dist/MyComponent'

...

<MyComponent prop="yes please" />

💅 Style management

CSS Modules

✨ Developer experience

• yarn start or yarn dev - Starts the documentation at http://localhost:3000/
• yarn watch - rollup watches any changes (not really needed)
• yarn build - builds the component library
• yarn build:web - builds the docs
• yarn test - runs any tests

Docz

The docs are built with ❤️ from docz

Create a new component with Plop Component Generator

1. yarn plop and follow the prompt or yarn plop MyComponent will generate MyComponent.jsx, myComponent.module.scss, MyComponent.test.js, and MyComponent.mdx
2. Update package.json according to semver.
3. Give a description of what changed in src/CHANGELOG.mdx followed by who made the changes.
4. Profit 💰

Automatic code formatting

prettier is an opinionated code formatter aiming to provide codebase consistency when multiple developers work on the same project. The main reason behind adopting Prettier is to stop all the on-going debates over coding styles.

Linting

Linters are tools that analyze source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.

• JavaScript is linted by ESLint, enforcing the Airbnb JavaScript Style Guide through an overridable set of rules provided by eslint-config-airbnb-base.
• Styles are linted by stylelint, adhering to the rules specified in stylelint-config-recommended.

---