Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boringcodes/create-package
:airplane: Boring TypeScript Package Generator - @boringcodes
https://github.com/boringcodes/create-package
boringcodes cli eslint husky lint-staged npm nvm prettier rollup standard-version typescript yeoman
Last synced: 2 months ago
JSON representation
:airplane: Boring TypeScript Package Generator - @boringcodes
- Host: GitHub
- URL: https://github.com/boringcodes/create-package
- Owner: boringcodes
- License: mit
- Created: 2020-02-21T07:07:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:57:24.000Z (about 2 years ago)
- Last Synced: 2024-11-19T00:44:37.201Z (3 months ago)
- Topics: boringcodes, cli, eslint, husky, lint-staged, npm, nvm, prettier, rollup, standard-version, typescript, yeoman
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-create-package
- Size: 774 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
create-package
Boring TypeScript Package Generator
## Features
Generated package includes the following features:
- [x] [RollupJS](https://rollupjs.org) with [@rollup/plugin-typescript](https://github.com/rollup/plugins/blob/master/packages/typescript), [@rollup/plugin-node-resolve](https://github.com/rollup/plugins/blob/master/packages/node-resolve) & [@rollup/plugin-commonjs](https://github.com/rollup/plugins/blob/master/packages/commonjs)
- [x] [Prettier](https://prettier.io) with [@boringcodes/prettier-config](https://github.com/boringcodes/prettier-config)
- [x] [ESLint](https://eslint.org) with [@boringcodes/eslint-config-typescript](https://github.com/boringcodes/eslint-config-typescript)
- [x] [Husky](https://github.com/typicode/husky)
- [x] [Lint Staged](https://github.com/okonet/lint-staged)
- [x] [Standard Version](https://github.com/conventional-changelog/standard-version)
## Installation
Make sure `yeoman` is installed
```sh
$ yarn global add yo
```
Then install the generator
```sh
$ yarn global add generator-create-package
```
## Usage
Create a new directory
```sh
$ mkdir package-name
```
Then navigate to the created directory and run the following command to generate source
```sh
$ yo create-package
```
This scaffolds out:
```
├── .husky
├── src
│ └── index.ts
├── .gitignore
├── package.json
├── README.md
├── rollup.config.js
└── tsconfig.json
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Authors
[BoringCodes](https://github.com/boringcodes)
## License
[MIT](https://github.com/boringcodes/create-package/blob/master/LICENSE)