https://github.com/xavdid/generator-xavdid
[Utility] Start Typescript projects the same way I do!
https://github.com/xavdid/generator-xavdid
typescript typescript-boilerplate yeoman yeoman-generator
Last synced: 3 months ago
JSON representation
[Utility] Start Typescript projects the same way I do!
- Host: GitHub
- URL: https://github.com/xavdid/generator-xavdid
- Owner: xavdid
- Created: 2018-10-22T03:33:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-22T05:25:33.000Z (almost 2 years ago)
- Last Synced: 2025-04-01T18:15:42.482Z (3 months ago)
- Topics: typescript, typescript-boilerplate, yeoman, yeoman-generator
- Language: TypeScript
- Homepage: https://npmjs.org/package/generator-xavdid
- Size: 1.75 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# generator-xavdid
[](https://npmjs.org/package/generator-xavdid)
## The Why
I've been writing a bunch of typescript and had gotten frustrated after setting up the same few tools, build steps, and testing frameworks repeatedly. So, I set up a generator to scaffold out projects just how I like them. Feel free to use it if you want to write typescript code using the same starting setup as I do! Also sets up my [eslint config](https://github.com/xavdid/eslint-config-xavdid).
Built on the awesome shoulders of [Yeoman](http://yeoman.io).
## Installation
First, install [Yeoman](http://yeoman.io) and `generator-xavdid` using the tool of your choice.
```bash
yarn global add yo generator-xavdid
```
Then, generate your new project:
```bash
yo xavdid
```
## Development
Most of the work will take place in `app/index.ts`, to focus there!
To test the unreleased version, run `yo ../path/to/this/folder`
### State of the Project
As of time of writing (`2023-08-21`) Yeoman is releasing it's 6.0.0 version and its docs are out of date. The package is back in working order on Node 18+, but the tests don't work.
I could update it to the new framework once everything is ironed out, but I might not be able to use `typed-install` in the same way.
I'm not sure if I wouldn't get better mileage out of a single clean build and a github template repository. Just in case, I've started one [here](https://github.com/xavdid/xavdid-ts-template).
## License
MIT © [David Brownman](https://xavd.id)