https://github.com/in-ch/setup

@in-ch/setup is a powerful tool for quickly setting up various project files and configurations.
https://github.com/in-ch/setup

eslint eslint-config git gitmessage husky husky-config lighthouse prettier prettier-config setting setup

Last synced: 7 days ago
JSON representation

@in-ch/setup is a powerful tool for quickly setting up various project files and configurations.

• Host: GitHub
• URL: https://github.com/in-ch/setup
• Owner: in-ch
• License: mit
• Created: 2024-12-05T07:59:23.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-30T08:09:22.000Z (12 days ago)
• Last Synced: 2024-12-30T09:28:40.868Z (12 days ago)
• Topics: eslint, eslint-config, git, gitmessage, husky, husky-config, lighthouse, prettier, prettier-config, setting, setup
• Language: TypeScript
• Homepage:
• Size: 320 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





[![npm downloads](https://img.shields.io/npm/dm/%40in-ch%2Fsetup.svg?style=for-the-badge)](https://www.npmjs.com/package/@in-ch/setup)

[![npm total downloads](https://img.shields.io/npm/dt/%40in-ch%2Fsetup.svg?style=for-the-badge)](https://www.npmjs.com/package/@in-ch/setup)

[![license](https://img.shields.io/npm/l/%40in-ch%2Fsetup?style=for-the-badge)](https://github.com/in-ch/setup/blob/master/LICENSE)

[![GitHub stars](https://img.shields.io/github/stars/in-ch/setup?style=for-the-badge)](https://github.com/in-ch/setup/stargazers)



### Features

`@in-ch/setup` is a powerful tool for quickly setting up various project files and configurations.

Save time and automate your setup process with the following commands:

| **Command**  | **Description**                               |

| ------------ | --------------------------------------------- |

| `husky`      | Creates Husky configuration files.            |

| `eslint`     | Generates ESLint configuration files.         |

| `gitmessage` | Creates a Git message template file.          |

| `prettier`   | Sets up Prettier configuration files.         |

| `typescript` | Creates TypeScript configuration files.       |

| `commitlint` | Adds Commitlint configuration.                |

| `edit`       | Edits existing configuration files.           |

| `init`       | Creates multiple configuration files at once. |

| `list`       | Lists all available commands.                 |

### Installation

To use `@in-ch/setup`, first install the package:

```bash

npm install -g @in-ch/setup

```

### Usage

Below are examples of how to use the primary commands of `@in-ch/setup`:

```bash

# Initialize essential configuration files (Husky, ESLint, Prettier, etc.)

ics setup init

# Add individual configuration files

# Husky setup

ics setup husky

# ESLint setup

ics setup eslint

# Git message template setup

ics setup gitmessage

# Prettier configuration

ics setup prettier

# TypeScript configuration

ics setup typescript

# Commit lint setup

ics setup commitlint

# Edit existing configuration files

ics setup edit

# List all available commands

ics setup list

```

### Why Use @in-ch/setup?

- **Save Time**: Automate the generation of multiple configuration files with a single command.

- **Ensure Consistency**: Easily enforce shared configurations across team projects.

- **Flexibility**: Edit generated files as needed to suit your project requirements.

### Contributors

Thanks go to these wonderful people! [[Become a contributor](CONTRIBUTING.md)].