@playbooks/utils
Version:
A collection of utilities used for Playbooks.
55 lines (35 loc) • 1.25 kB
Markdown
# Overview
A collection of utilities for various projects.
## Installation
```
npm install @playbooks/adapters
```
## Usage
```tsx
import React from 'react';
import { H6 } from '@ehubbell/html';
import { formatDate } from '@playbooks/utils';
const FormattedDate = ({ date }) => <H6>{formatDate(date, 'DDDD, MO, YYYY @ HH:MMa')}</H6>;
export { FormattedDate };
```
## Development
This project uses [yalc](https://npmjs.com/package/yalc) for local development.
- npm run dev
- switch to project
- npx yalc add @playbooks/utils
- After that, this library should hot reload into the consuming application
## Scripts
- We've included a couple of helpful scripts for faster development.
- deploy: `npm run deploy -- 'commit message'`
- publish: `npm run publish -- 'commit message' [major|minor|patch]`
## Husky
- Husky configuration is setup to lint and format the repo on every commit
- Edit the `.husky/pre-commit` file to change your settings
## Author
- [Eric Hubbell](http://www.erichubbell.com)
- eric@erichubbell.com
## Notes
To see this library in action, checkout the following projects:
- [playbooks](https://www.playbooks.xyz)
- [playbooks blog](https://blog.playbooks.xyz)
- [playbooks docs](https://docs.playbooks.xyz)