Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epranka/create-tsx-package
Starter kit for React Typescript package [DEPRECATED]
https://github.com/epranka/create-tsx-package
boilerplate create generator jsx package package-creation package-runner react semantic-release starter-kit templates travis tsx tsx-sample typescript
Last synced: 21 days ago
JSON representation
Starter kit for React Typescript package [DEPRECATED]
- Host: GitHub
- URL: https://github.com/epranka/create-tsx-package
- Owner: epranka
- License: isc
- Created: 2019-11-20T15:29:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T09:36:54.000Z (about 2 years ago)
- Last Synced: 2024-12-22T03:33:04.313Z (about 2 months ago)
- Topics: boilerplate, create, generator, jsx, package, package-creation, package-runner, react, semantic-release, starter-kit, templates, travis, tsx, tsx-sample, typescript
- Language: JavaScript
- Homepage:
- Size: 2.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
⚒️ @epranka/create-tsx-package
[DEPRECATED. See below]
Starter kit for React Typescript module
## DEPRECATION
This module supports only TSX package and may have issues. Please use [@epranka/create-package](https://github.com/epranka/create-package) because this module will no longer be maintained.
[@epranka/create-package](https://github.com/epranka/create-package) is clone of this module, but with JS, JSX, TS, TSX support and many improvements.
## Features
- Interactive package creation
- Silent mode
- Package manager selection (yarn or npm)
- Choices of ES, CJS, UMD modules and all together
- Rollup bundler
- Tests
- Semantic Release
- README template with badges
- Continuous integration: Travis
- License selection (ISC, MIT, UNLICENSED)
## Create package
1. With package runners
```bash
$ npx @epranka/create-tsx-package my-package
# or
$ yarn create @epranka/tsx-package my-package
```
2. Install globally
```bash
$ npm install -g @epranka/create-tsx-package
# or
$ yarn global add @epranka/create-tsx-package
# and then use
$ create-tsx-package my-package
```
If automated semantic releases are selected, package generation will take longer
## CLI Help
```
Usage:
$ create-tsx-package [out-dir]
Commands:
[out-dir] Generate in a or current directory
For more info, run any command with the `--help` flag:
$ create-tsx-package --help
Options:
-i, --info Print out debugging information relating to the local environment
-s, --silent Silent mode. Create package without user interaction
--name Name of the package
--description Description of the package
--author Author of package
--email of author
--mit MIT license. Default is ISC
--umd Build UMD module with
--unlicensed Unlicensed. This option overrides --mit option
--no-private No private:true property in package.json (default: true)
--no-es Don't build ES Module (default: true)
--no-travis Don't use travis ci. (default: true)
--no-tests Don't use tests (default: true)
--no-semantic-release Don't use semantic release (default: true)
--npm Use NPM package manager. Default is YARN
--verbose Show debug logs
-h, --help Display this message
-v, --version Display version number
```
## Structure
Created package will have following structure (if tests, Semantic Release and Travis is selected)
```
my-package
├── src
│ └── index.tsx
├── __tests__
│ └── index.spec.tsx
├── node_modules
├── jest.config.js
├── LICENSE
├── package.json
├── README.md
├── rollup.config.js
├── tsconfig.json
├── tslint.json
└── yarn.lock
```
## Build
```bash
# to build
$ npm run build
# or
$ yarn build
# to watch changes
$ npm run watch
# or
$ yarn watch
```
## Badge
Let people know that your package is generated using **@epranka/create-tsx-package** by including this badge in your readme
Using Markdown
```
[](https://github.com/epranka/create-tsx-package)
```
Using HTML
```
```
## Author
Edvinas pranka ([[email protected]](mailto:[email protected]))
Follow on Twitter [@epranka](https://twitter.com/epranka)
https://www.kodmina.lt
## License
ISC License
Copyright (c) 2019, Edvinas Pranka ([email protected])
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.