{"id":18278051,"url":"https://github.com/tanem/generator-typescript-react-lib","last_synced_at":"2025-08-11T17:12:39.972Z","repository":{"id":37935128,"uuid":"143766248","full_name":"tanem/generator-typescript-react-lib","owner":"tanem","description":":nut_and_bolt: A Yeoman generator for React libs written with Typescript.","archived":false,"fork":false,"pushed_at":"2025-08-10T14:47:20.000Z","size":3912,"stargazers_count":20,"open_issues_count":8,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-10T16:30:33.539Z","etag":null,"topics":["library","react","typescript","yeoman-generator"],"latest_commit_sha":null,"homepage":"https://npm.im/generator-typescript-react-lib","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tanem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-06T18:18:09.000Z","updated_at":"2024-12-30T03:30:28.000Z","dependencies_parsed_at":"2023-09-24T03:50:19.721Z","dependency_job_id":"2bd810df-accb-4aa2-8940-96aaf537e135","html_url":"https://github.com/tanem/generator-typescript-react-lib","commit_stats":{"total_commits":647,"total_committers":5,"mean_commits":129.4,"dds":0.5425038639876352,"last_synced_commit":"246992bf2e91441940db1fbbcc19dc30fc69eee7"},"previous_names":[],"tags_count":179,"template":false,"template_full_name":null,"purl":"pkg:github/tanem/generator-typescript-react-lib","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fgenerator-typescript-react-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fgenerator-typescript-react-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fgenerator-typescript-react-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fgenerator-typescript-react-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tanem","download_url":"https://codeload.github.com/tanem/generator-typescript-react-lib/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fgenerator-typescript-react-lib/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269922826,"owners_count":24496992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","react","typescript","yeoman-generator"],"created_at":"2024-11-05T12:22:47.264Z","updated_at":"2025-08-11T17:12:39.950Z","avatar_url":"https://github.com/tanem.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-typescript-react-lib\n\n[![npm version][npmv-image]][npmv-url]\n[![build status][build-image]][build-url]\n[![coverage status][codecov-image]][codecov-url]\n[![npm downloads][npmd-image]][npmd-url]\n\n\u003e A [Yeoman](http://yeoman.io) generator for [React](https://reactjs.org) libs written with [Typescript](https://www.typescriptlang.org).\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Background](#background)\n- [Features](#features)\n- [Installation](#installation)\n- [Common Workflows](#common-workflows)\n  - [Setup](#setup)\n  - [Development](#development)\n  - [Testing](#testing)\n  - [Publishing](#publishing)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Background\n\nTo 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.\n\n## Features\n\n- Generates CommonJS, ES module, and Universal Module Definition bundles via [Rollup](https://rollupjs.org).\n- Tests bundles via [Jest](https://jestjs.io/).\n- Generates Typescript type declarations for publishing.\n- Outputs, strips, or wraps [PropTypes](https://reactjs.org/docs/typechecking-with-proptypes.html) declarations according to bundle type.\n- Configures continuous integration via [GitHub Actions](https://github.com/features/actions).\n- Configures code coverage analysis via [Codecov](https://codecov.io/).\n- Configures [Renovate](https://renovatebot.com/) for dependency management.\n- Adds scripts for releasing to [npm](https://www.npmjs.com/).\n- Makes Universal Module Definition bundles available via [unpkg](https://unpkg.com/).\n- Initialises [Git](https://git-scm.com/).\n\n## Installation\n\nFirst, install Yeoman and generator-typescript-react-lib:\n\n```\n$ npm install -g yo generator-typescript-react-lib\n```\n\nThen generate your new library:\n\n```\n$ mkdir your-new-react-library \u0026\u0026 cd $_\n$ yo typescript-react-lib\n```\n\n## Common Workflows\n\n### Setup\n\n1. Create a new GitHub repository.\n2. [Install/enable](https://renovatebot.com/docs/install-github-app/) the Renovate GitHub app.\n3. Use this generator to create your lib.\n\n### Development\n\nEverything revolves around GitHub PRs:\n\n1. Create a new local branch.\n2. Add a remote tracking branch.\n3. Make some changes.\n4. Push the changes.\n5. Open a PR.\n\nIt's also recommended to set branch protection rules against the `master` branch by selecting the following:\n\n- `Require status checks to pass before merging`.\n- `Require branches to be up to date before merging`.\n- `ci`.\n\n### Testing\n\nRunning `npm test` will:\n\n- Check code style with Prettier.\n- Type check with TypeScript.\n- Build the package assets.\n- Test the package assets.\n\n### Publishing\n\nOnce the PR checks have passed:\n\n1. Merge the PR.\n2. Checkout the `master` branch.\n3. Ensure `master` is up-to-date.\n4. Run `npm release \u003cnewversion\u003e`. Refer to the [npm-version](https://docs.npmjs.com/cli/version) docs for information on the `newversion` argument.\n\nThe `release` script will:\n\n1. Bump the `package.json` version.\n1. Run the test flow.\n1. Generate a `CHANGELOG.md` that includes these latest changes.\n1. Generate or update the `AUTHORS` file.\n1. Make a version commit and tag.\n1. Push the commit and tag to GitHub.\n1. Publish the package to npm.\n\n## License\n\nMIT\n\n[build-image]: https://img.shields.io/github/actions/workflow/status/tanem/generator-typescript-react-lib/ci.yml?branch=master\u0026style=flat-square\n[build-url]: https://github.com/tanem/generator-typescript-react-lib/actions?query=workflow%3ACI\n[codecov-image]: https://img.shields.io/codecov/c/github/tanem/generator-typescript-react-lib.svg?style=flat-square\n[codecov-url]: https://codecov.io/gh/tanem/generator-typescript-react-lib\n[npmv-image]: https://img.shields.io/npm/v/generator-typescript-react-lib.svg?style=flat-square\n[npmv-url]: https://www.npmjs.com/package/generator-typescript-react-lib\n[npmd-image]: https://img.shields.io/npm/dm/generator-typescript-react-lib.svg?style=flat-square\n[npmd-url]: https://www.npmjs.com/package/generator-typescript-react-lib\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanem%2Fgenerator-typescript-react-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftanem%2Fgenerator-typescript-react-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanem%2Fgenerator-typescript-react-lib/lists"}