https://github.com/liruifengv/create-lint-config

An easy way to create all lint configuration such as ESLint、Prettier.
https://github.com/liruifengv/create-lint-config

commitlint eslint eslint-config prettier prettier-config stylelint

Last synced: 4 months ago
JSON representation

An easy way to create all lint configuration such as ESLint、Prettier.

• Host: GitHub
• URL: https://github.com/liruifengv/create-lint-config
• Owner: liruifengv
• License: mit
• Created: 2022-08-25T12:22:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T09:53:13.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T01:20:16.386Z (4 months ago)
• Topics: commitlint, eslint, eslint-config, prettier, prettier-config, stylelint
• Language: TypeScript
• Homepage:
• Size: 275 KB
• Stars: 24
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# create-lint-config

![version](https://img.shields.io/npm/v/create-lint-config)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/liruifengv/create-lint-config/pulls)

![license](https://img.shields.io/npm/l/create-lint-config)

![npm total downloads](https://img.shields.io/npm/dt/create-lint-config.svg)

![npm month downloads](https://img.shields.io/npm/dm/create-lint-config.svg)

![downloads](https://img.shields.io/npm/dw/create-lint-config)

English | [简体中文](./README.zh-CN.md)

### An easy way to create all lint configuration.

#### A particularly large number of config files distracted us. Our goal is to generate these configurations quickly and easily!

## Usage

### 1. Use default

We offer a shortcut method to generate all default configurations with one click, it includes Eslint, Prettier, StyleLint, CommitLint, husky, lint-staged, and many more.

Execute the following command at the root of your project:

```bash

# npm

npm create lint-config@latest

# yarn

yarn create lint-config

# pnpm

pnpm create lint-config@latest

```

![screenshot](screenshot.png)

### 2. Use prompt step by step

You can also pass the `--input / -i` flag to enable more flexible options and generate the configuration you want step by step.

```bash

# npm 6.x

npm create lint-config@latest -i

# npm 7+, extra double-dash is needed:

npm create lint-config@latest -- -i

```

![screenshot-i](screenshot-i.png)

## 3. Use `--template` flag

You can use templates by passing the `--template` flag.

```bash

# npm 6.x

npm create lint-config@latest --template vue

# npm 7+, extra double-dash is needed:

npm create lint-config@latest -- --template vue

```

More templates can be found in the [template folder](https://github.com/liruifengv/create-lint-config/tree/main/template).

You can also submit your own templates via [PR](https://github.com/liruifengv/create-lint-config/pulls).

Template in plan

- [x] vue

- [x] vue2

- [ ] vue-ts

- [x] react

- [x] react-ts

- [x] node

- [x] node-ts

- [ ] astro

- [ ] svelte

- [ ] solidjs

- [ ] and more

## Features

- [x] Generate eslint config.

- [x] Generate prettier config.

- [x] Generate stylelint config.

- [x] Generate husky config.

- [x] Generate commitlint config.

- [ ] And more.

### CLI Flags

| Name                | Description                                   |

| :------------------ | :-------------------------------------------- |

| `--help` (`-h`)     | Help info                                     |

| `--template ` | Use template                                  |

| `--input` (`-i`)    | Use prompt step by step to config your wanted |

## ISSUE

Please [contact me](https://github.com/liruifengv/create-lint-config/issues) if you encounter any problems.

## Contributing

Contribution guidelines are coming.

You can still give PR, create more template files and support more configurations.

You can also fork this project and turn it into your own scaffolding. This is allowed.

## License

create-lint-config is released under the MIT License. See the bundled

[LICENSE](./LICENSE) file for details.