ep-setup
v1.0.6
Published
Ep-setup š ===========
Readme
Ep-setup š
Automated ESLint and Prettier Setup for TypeScript Projects
š Installation and Usage
Without Global Installation (Recommended)
If you don't want to installĀ ep-setupĀ globally, simply run:
npx ep-setup
š Description
ep-setupĀ is a CLI tool that automatically installs and configuresĀ ESLintĀ andĀ PrettierĀ in your project.No more manual setup of configuration files or installing dependencies ā just run a single command!
ā What doesĀ ep-setupĀ do?
Creates configuration filesĀ .eslintrc.jsĀ andĀ .prettierrc
Installs necessary dependencies
ConfiguresĀ TypeScript,Ā Prettier,Ā ESLint,Ā TailwindCSSĀ (plugin)
Adds import sorting
Prepares your project for clean and consistent code style
š§ Supported Technologies
ESLintĀ (Code Analysis)
PrettierĀ (Code Formatting)
TypeScriptĀ (Strict Typing Support)
TailwindCSSĀ (Plugin for Class Sorting)
Import SortingĀ (Automatic Import Order in Files)
š Requirements
Node.js 14+
npmĀ orĀ yarn
š ļø How It Works
RunĀ npx ep-setupĀ in your project directory.
The tool will:
Install all required dependencies (eslint,Ā prettier,Ā @trivago/prettier-plugin-sort-imports,Ā prettier-plugin-tailwindcss, etc.).
GenerateĀ .eslintrc.jsĀ andĀ .prettierrcĀ configuration files.
Configure ESLint and Prettier to work seamlessly with TypeScript and TailwindCSS.
You're ready to go! Start coding with a clean and consistent style.
š Example
After runningĀ npx ep-setup, your project will have:
ESLintĀ configured for TypeScript.
PrettierĀ with plugins for import sorting and TailwindCSS class sorting.
A pre-configuredĀ .eslintrc.jsĀ andĀ .prettierrcĀ file.
š Generated Files
.eslintrc.js: ESLint configuration for TypeScript.
.prettierrc: Prettier configuration with plugins for import sorting and TailwindCSS.
š License
This project is licensed under the MIT License. See theĀ LICENSEĀ file for details.
š Credits
ESLint: For code analysis.
Prettier: For code formatting.
@trivago/prettier-plugin-sort-imports: For sorting imports.
prettier-plugin-tailwindcss: For sorting TailwindCSS classes.
š Get Started
Run the following command to set up your project:
npx ep-setup
Enjoy clean and consistent code! š
