sn-donbenjamin / react-utilities

React Utilities to speed up and simplify development 🏎(setup in progress)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

React Utilities

React Utilities to speed up and simplify development 🏎


The goal of the project is to provide everyday components, in example window scroll detection, to speed up and simplify React development with little to no extra boilerplate code. In this eco-system/monorepo, everyday React utilities can be implemented and tested so that users of this repository's utilities can use the provided utilities with confidence and without much thought.


Usage

In this section, how to use specific React Utilities will be supplied.

import { SomeReactUtility } from '@react-utilities/some-react-utility

const SomeReactComponent: FunctionComponent<SomeReactComponentProps> = (): JSX.Element => 
  (<SomeReactUtility><p>Foo</p></SomeReactUtility>)

Development

Listed below are steps and commands for developing new React Utilities or fixing/updating current react utilities.

Commands

Commands for developing React Utilities

  • build: builds all packages in parallel
  • clean: cleans up all build files for all packages
  • ci: shortcut command to run CI-friendly conformance checks for lint, typescript checks, and tests
  • lint: runs lint and auto-fixes code if necessary
  • test: runs all tests
    • Shortcut for jest. You can pass any jest CLI flags to this command like --watch
  • tsc: runs a noEmit Typescript check across all files.

Thanks

This project is being built referencing Paul Armstrong's Monorepo TS with additions for react development supplied by me, Jeff Wainwright.

About

React Utilities to speed up and simplify development 🏎(setup in progress)

License:MIT License


Languages

Language:TypeScript 79.7%Language:JavaScript 20.3%