package-example

Example of simple opensource library with totally useless content 🙃

Point of this package is to show:

1. how to create an opensource project and publish it to npm
2. how to build a library with rollup bundler in esm/cjs formats
3. how to make "tree-shakable" library
4. how to write simple CLI script
5. how to use Storybook for development

Usage

First things first, install package:

yarn add @p1t1ch/package-example

Library provides React component Operation and math helpers:

import React from 'react';
import { Operation, math } from '@p1t1ch/package-example';

const SomeComponent = () => <Operation a={16} b={13} func={math.sum} />;

And dummy CLI script – log with "Hello" and yor name from -n argument:

# Hello, p1t1ch
npx package-example -n p1t1ch

Development

| yarn <command> | Description | | ----------------- | ----------------------------------------------- | | storybook | Starts a Storybook in dev mode | | storybook:build | Build static Storybook version in docs folder | | storybook:serve | Starts a static server for docs browsing | | build | Build package | | eslint | Lint all .js, .jsx, .ts and .tsx files |