Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanem/generator-typescript-react-lib
:nut_and_bolt: A Yeoman generator for React libs written with Typescript.
https://github.com/tanem/generator-typescript-react-lib
library react typescript yeoman-generator
Last synced: 7 days ago
JSON representation
:nut_and_bolt: A Yeoman generator for React libs written with Typescript.
- Host: GitHub
- URL: https://github.com/tanem/generator-typescript-react-lib
- Owner: tanem
- License: mit
- Created: 2018-08-06T18:18:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T03:53:38.000Z (7 months ago)
- Last Synced: 2024-04-14T14:59:27.228Z (7 months ago)
- Topics: library, react, typescript, yeoman-generator
- Language: JavaScript
- Homepage: https://npm.im/generator-typescript-react-lib
- Size: 3.56 MB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# generator-typescript-react-lib
[![npm version][npmv-image]][npmv-url]
[![build status][build-image]][build-url]
[![coverage status][codecov-image]][codecov-url]
[![npm downloads][npmd-image]][npmd-url]
> A [Yeoman](http://yeoman.io) generator for [React](https://reactjs.org) libs written with [Typescript](https://www.typescriptlang.org).
## Table of Contents
- [Background](#background)
- [Features](#features)
- [Installation](#installation)
- [Common Workflows](#common-workflows)
- [Setup](#setup)
- [Development](#development)
- [Testing](#testing)
- [Publishing](#publishing)
- [License](#license)
## Background
To provide a basic starting point when authoring React libraries with Typescript. By design not all use-cases will be handled, so some post-generation modifications may be required.
## Features
- Generates CommonJS, ES module, and Universal Module Definition bundles via [Rollup](https://rollupjs.org).
- Tests bundles via [Jest](https://jestjs.io/).
- Generates Typescript type declarations for publishing.
- Outputs, strips, or wraps [PropTypes](https://reactjs.org/docs/typechecking-with-proptypes.html) declarations according to bundle type.
- Configures continuous integration via [GitHub Actions](https://github.com/features/actions).
- Configures code coverage analysis via [Codecov](https://codecov.io/).
- Configures [Renovate](https://renovatebot.com/) for dependency management.
- Adds scripts for releasing to [npm](https://www.npmjs.com/).
- Makes Universal Module Definition bundles available via [unpkg](https://unpkg.com/).
- Initialises [Git](https://git-scm.com/).
## Installation
First, install Yeoman and generator-typescript-react-lib:
```
$ npm install -g yo generator-typescript-react-lib
```
Then generate your new library:
```
$ mkdir your-new-react-library && cd $_
$ yo typescript-react-lib
```
## Common Workflows
### Setup
1. Create a new GitHub repository.
2. [Install/enable](https://renovatebot.com/docs/install-github-app/) the Renovate GitHub app.
3. Use this generator to create your lib.
### Development
Everything revolves around GitHub PRs:
1. Create a new local branch.
2. Add a remote tracking branch.
3. Make some changes.
4. Push the changes.
5. Open a PR.
It's also recommended to set branch protection rules against the `master` branch by selecting the following:
- `Require status checks to pass before merging`.
- `Require branches to be up to date before merging`.
- `ci`.
### Testing
Running `npm test` will:
- Check code style with Prettier.
- Type check with TypeScript.
- Build the package assets.
- Test the package assets.
### Publishing
Once the PR checks have passed:
1. Merge the PR.
2. Checkout the `master` branch.
3. Ensure `master` is up-to-date.
4. Run `npm release `. Refer to the [npm-version](https://docs.npmjs.com/cli/version) docs for information on the `newversion` argument.
The `release` script will:
1. Bump the `package.json` version.
1. Run the test flow.
1. Generate a `CHANGELOG.md` that includes these latest changes.
1. Generate or update the `AUTHORS` file.
1. Make a version commit and tag.
1. Push the commit and tag to GitHub.
1. Publish the package to npm.
## License
MIT
[build-image]: https://img.shields.io/github/actions/workflow/status/tanem/generator-typescript-react-lib/ci.yml?branch=master&style=flat-square
[build-url]: https://github.com/tanem/generator-typescript-react-lib/actions?query=workflow%3ACI
[codecov-image]: https://img.shields.io/codecov/c/github/tanem/generator-typescript-react-lib.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/tanem/generator-typescript-react-lib
[npmv-image]: https://img.shields.io/npm/v/generator-typescript-react-lib.svg?style=flat-square
[npmv-url]: https://www.npmjs.com/package/generator-typescript-react-lib
[npmd-image]: https://img.shields.io/npm/dm/generator-typescript-react-lib.svg?style=flat-square
[npmd-url]: https://www.npmjs.com/package/generator-typescript-react-lib