Skip to content

An easy way to create all lint configuration.

License

Notifications You must be signed in to change notification settings

SealUI/create-lint-config

 
 

Repository files navigation

create-lint-config

version PRs Welcome license npm total downloads npm month downloads downloads

English | 简体中文

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:

# npm
npm create lint-config@latest

# yarn
yarn create lint-config

# pnpm
pnpm create lint-config@latest

screenshot

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.

# npm 6.x
npm create lint-config@latest -i
# npm 7+, extra double-dash is needed:
npm create lint-config@latest -- -i

screenshot-i

Features

  • Generate eslint config.
  • Generate prettier config.
  • Generate stylelint config.
  • Generate husky config.
  • Generate commitlint config.
  • And more.

CLI Flags

Name Description
--help (-h) Help info
--template <name> Coming soon
--input (-i) Use prompt step by step to config your wanted

TODO

  • Support for selecting templates by passing -- template flag.

ISSUE

Please contact me 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 file for details.

About

An easy way to create all lint configuration.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 72.5%
  • JavaScript 27.5%