Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freekmencke/node-ts-starter-cli
Node TS Starter CLI makes setting up a new TypeScript Node.js project a breeze. Choose from advanced features like strict TS config, esbuild, Docker support, Prettier, and more.
https://github.com/freekmencke/node-ts-starter-cli
cli commitizen create docker esbuild eslint github-actions nodejs prettier starter typescript
Last synced: 4 months ago
JSON representation
Node TS Starter CLI makes setting up a new TypeScript Node.js project a breeze. Choose from advanced features like strict TS config, esbuild, Docker support, Prettier, and more.
- Host: GitHub
- URL: https://github.com/freekmencke/node-ts-starter-cli
- Owner: FreekMencke
- License: mit
- Created: 2023-01-10T18:01:58.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T13:52:58.000Z (7 months ago)
- Last Synced: 2024-10-04T05:41:47.100Z (4 months ago)
- Topics: cli, commitizen, create, docker, esbuild, eslint, github-actions, nodejs, prettier, starter, typescript
- Language: JavaScript
- Homepage: https://npmjs.com/package/node-ts-starter-cli
- Size: 570 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/node-ts-starter-cli)
[](https://github.com/FreekMencke/node-ts-starter-cli/actions/workflows/main.yml)
[](https://github.com/FreekMencke/node-ts-starter-cli/issues)
[](https://github.com/FreekMencke/node-ts-starter-cli/blob/master/LICENSE)
# Node TS Starter CLI
Since I make a lot of projects, I created this **Node TS Starter CLI** to easily create a new Node project with
TypeScript.
## Getting started
To get started with the Node TS Starter CLI, simply run the following command in your command line interface:
```
npx node-ts-starter-cli create your-project-name -M
```
The command will generate your project in the `./your-project-name/` folder.
For an example of a generated project you can look at the
[example](https://github.com/FreekMencke/node-ts-starter-cli/tree/master/example).
## Features
- Strict TypeScript configuration
- Compiled and bundled with [esbuild](https://esbuild.github.io/)
- Commitizen (`-c`)
- ESLint (`-l`)
- Prettier (`-p`)
- Docker support (`-d`)
- Github Action CI (`-g`)
- Separate Dev/Prod config files (`-e`)
### Analyzing your bundle
With esbuild we can generate a `meta.json` file using the `npm run build:meta` or `npm run build:meta:prod` commands,
which we can then can be uploaded to [Bundle Buddy](https://bundle-buddy.com/esbuild) to perform a detailed bundle
analasys.
The Node TS Starter CLI offers additional options such as `--minimal` and `--maximal` for a minimal or maximal project
setup, as well as options for linting, Docker support, and config per environment. You can find a full list of options
by running `node-ts-starter-cli create --help`.
```
node-ts-starter-cli create [args]
Creates a new project.
Positionals:
name Project and folder name [string] [required] [default: "node-typescript-starter"]
Creation options
-m, --minimal Project setup without any features and minimal code. [boolean]
-M, --maximal Project setup with all features. [boolean]
-d, --docker Adds support for Docker. [boolean]
-g, --github-action Adds Github Action CI. [boolean]
-l, --eslint Adds linting configuration. [boolean]
-e, --environments Adds support for config per environment. [boolean]
-c, --commitizen Adds commitizen for clean commits. [boolean]
-p, --prettier Adds prettier configuration. [boolean]
Options:
--version Show version number [boolean]
--help Show help [boolean]
```
## Support
If you have any issues or questions, please feel free to open a
[GitHub issue](https://github.com/FreekMencke/node-ts-starter-cli/issues).