ts-easy

ts-easy - is your minimalist TypeScript starter for Node.js projects. No fluff, just the essentials to get you up and running with TypeScript, ESLint, Prettier, and more. Perfect for initiating any TypeScript project, whether it's a CLI tool, library, or something entirely different.

MIT License

Stars
26
Committers
1

ts-easy πŸ› οΈ

ts-easy is your minimalist TypeScript starter for Node.js projects. No fluff, just the essentials to get you up and running with TypeScript, ESLint, Prettier, and more. Perfect for initiating any TypeScript project, whether it's a CLI tool, library, or something entirely different.

Features ✨

  • TypeScript: Strongly typed JavaScript for the win.
  • ESLint: Keep your code clean and consistent.
  • Prettier: Automatic code formatting to keep everything looking sharp.
  • VSCode Settings: Optimized workspace settings out of the box.
  • pnpm: Fast, disk space-efficient package manager.
  • ts-node-dev: Instant feedback with autoreload on save.
  • tsup: Super fast TypeScript bundler.
  • Zod: Type-safe schema validation made easy.

Getting Started πŸš€

1. Clone the Repository

git clone https://github.com/yourusername/ts-easy.git
cd ts-easy

2. Install Dependencies

Make sure you have pnpm installed. Then, run:

pnpm install

3. Start Developing

Kickstart your development with autoreload on save:

pnpm dev

4. Build for Production

Ready to ship? Build your project with:

pnpm build

Project Structure πŸ“

ts-easy/
β”œβ”€β”€ src/
β”‚   └── main.ts      	# Entry point for your TypeScript project
β”œβ”€β”€ .vscode/
β”‚   └── settings.json 	# VSCode workspace settings
β”‚   └── extensions.json # Recommended VSCode extensions
β”œβ”€β”€ eslint.config.mjs   # ESLint configuration
β”œβ”€β”€ build.ts      	# Build configurations for tsup
β”œβ”€β”€ .prettierrc      	# Prettier configuration
β”œβ”€β”€ tsconfig.json    	# TypeScript configuration
β”œβ”€β”€ package.json     	# Project metadata and scripts
└── pnpm-lock.yaml   	# Dependency lockfile

Scripts πŸ“

  • pnpm dev: Run your project with autoreload.
  • pnpm start: Run your build.
  • pnpm lint: Lint your TypeScript code using ESLint.
  • pnpm lint:fix: Lint and fix your TypeScript code using ESLint.
  • pnpm format: Format your code with Prettier.
  • pnpm build: Bundle your project using tsup.

Why ts-easy? πŸ€”

  • Minimal: Just the essentials, no bloat.
  • Flexible: Use it for any TypeScript-based project.
  • Modern: Includes the latest and greatest tools like tsup and Zod.

License πŸ“„

This project is licensed under the MIT License.

Related Projects