https://github.com/baltpeter/generator-ts
A Yeoman generator I use for scaffolding TypeScript modules.
https://github.com/baltpeter/generator-ts
Last synced: 5 months ago
JSON representation
A Yeoman generator I use for scaffolding TypeScript modules.
- Host: GitHub
- URL: https://github.com/baltpeter/generator-ts
- Owner: baltpeter
- License: cc0-1.0
- Created: 2023-01-09T12:27:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T13:14:11.000Z (over 1 year ago)
- Last Synced: 2025-10-26T19:51:36.798Z (8 months ago)
- Language: JavaScript
- Size: 43 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @baltpeter/generator-ts
> A Yeoman generator that I use for scaffolding TypeScript modules.
This Yeoman generator generates the TypeScript boilerplate I use for my modules, using my configs for ESLint, Prettier and TypeScript. You probably don't want to use this unless you're working on a project with me.
## Installation
You first need to install `yo` and this generator:
```sh
npm i -g yo @baltpeter/generator-ts
```
## Usage
After installing, you can run the generator with:
```sh
yo @baltpeter/ts
```
The generator will interactively prompt you for the module name and some other information. You can also pass most of these options as command line arguments. Use `yo @baltpeter/ts --help` to see all available options:
```
$ yo @baltpeter/ts --help
Usage:
yo @baltpeter/ts:app [] [options]
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--skip-install # Do not automatically install dependencies Default: false
--force-install # Fail on install dependencies error Default: false
--ask-answered # Show prompts for already configured options Default: false
--description # A short one-sentence description of the module.
--name # Your name.
--email # Your email.
--githubRepo # The GitHub repository where the module will be stored.
--useTypeDoc # Whether to use TypeDoc for generating the API docs as Markdown.
Arguments:
moduleName # The name of the module (this will also be the output directory). Type: String Required: false
```
## License
This generator and the boilerplate it generates are licensed under the CC0 license, see the [`LICENSE`](LICENSE) file for details.