create-4bh1-ts-eslint

create-4bh1-ts-eslint is a CLI tool that helps you quickly set up a new TypeScript project with ESLint pre-configured. This tool automates the setup process, enabling you to start developing with a clean, linted TypeScript environment from the get-go.

Features

• TypeScript Configuration: Initializes a TypeScript project with tsconfig.json configured for best practices.
• ESLint Setup: Automatically sets up ESLint with TypeScript support and popular plugins.
• Predefined Rules: Comes with sensible ESLint rules tailored for TypeScript development.
• Git Ignore: Adds a .gitignore file for common Node.js and TypeScript-related files and directories.
• VS Code Integration: Includes VS Code settings for optimal TypeScript and ESLint integration.
• NPM Scripts: Pre-configured npm scripts for building, development, and linting.

Installation & Usage

To create a new TypeScript project, run:

npx create-4bh1-ts-eslint@latest

Follow the prompts to name your project. The tool will automatically:

1. Create a new project directory
2. Set up TypeScript configuration
3. Configure ESLint with TypeScript support
4. Install necessary dependencies
5. Create initial project structure

Project Structure

After running the tool, your project will have the following structure:

your-project/
├── .vscode/
│   └── settings.json
├── src/
│   └── index.ts
├── .eslintrc.mjs
├── .gitignore
├── package.json
└── tsconfig.json

Included Scripts

The following npm scripts are included in your package.json:

• npm run dev - Run the development server using ts-node
• npm run build - Build the TypeScript project
• npm run lint:check - Check for linting issues
• npm run lint:fix - Automatically fix linting issues

Dependencies

The project includes the following development dependencies:

• typescript
• eslint
• @eslint/js
• @typescript-eslint
• globals
• @types/node
• ts-node

VS Code Integration

The project includes VS Code settings that:

• Enable ESLint integration for various file types
• Configure flat config support for ESLint

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open source and available under the MIT License.