stylelintrc-generator

A simple CLI tool to create .stylelintrc.json file perfectly compatible with your project and code formatter Prettier written in TypeScript. Answer some simple questions and get your RC file, as well as all the packages, installed

Usage no npm install needed!

<script type="module">
  import stylelintrcGenerator from 'https://cdn.skypack.dev/stylelintrc-generator';
</script>

README

Project logo

stylelintrc-generator

A simple CLI tool to create .stylelintrc.json file perfectly compatible with your project and code formatter Prettier written in TypeScript
Answer some simple questions and get your RC file as well as all the packages installed
NPM Package · Report Bug · Request Feature

npm Status GitHub issues GitHub forks GitHub stars GitHub pull requests GitHub License


Project Demo Gif

Stylelintrc-Generator is a simple but time-saving command-line tool that will help you help you setup your project and code formatter with all the style configuration you want. You just have to answer some really simple questions and this tool will do all the heavy lifting for you creating the file according to config and installing all the packages.

💡 Features

  1. Uses BEM conventions
  2. Perfectly compatible with
    • Scss
    • CSS
    • Prettier
  3. Ask questions and creates config based on your choice
  4. You have complete control over the configuration
  5. Checks for package.json file and npm init -y if not found
  6. Installs all required packages as dev dependency as per the config
  7. Uses your preferred package manager

⛏️ Built with

  • Inquirer
  • Listr
  • Execa

🏁 Getting Started

Follow all these instructions and learn the best way to take benefits from this package.

📚 Prerequisite

  • Node
  • npm/yarn

🧰 Installation

  1. Global installation (preferred way)

    npm i stylelintrc-generator -g

    Note: Global installation is not possible with yarn v2 as far as I know, (please guide me if I am wrong). If you are using yarn v1 then use yarn global add stylelintrc-generator. But I recommend using the global method

  2. Per project installation

    npm i stylelintrc-generator -D

            or

yarn add stylelintrc-generator -D

  3. Command to generate RC file

    npx generate-stylelintrc

         or

generate-stylelintrc

🎈 Usage

The sole motive of this package is to improve Developer Experience. The package is made to save time configuring Style Pattern and Prettier, with your project. The tool will ask you certain questions, prepare a config and required packages list based on your answers, install all the packages and create the RC file perfectly compatible with your project as well as Prettier. You just need to focus on building your awesome project.

✍️ Authors

📖 Contributing

"In real open source, you have the right to control your own destiny." - Linus Torvalds

Contributions are what makes the open-source community an amazing place. Any contributions you make are greatly appreciated.

💳 License

Distributed under the MIT License. See LICENSE for more information.

🧬 Resources

🎉 Acknowledgement

👋 EndNote

Star this project so you don't miss it when you need it and avoid wasting time Googling the stuff and just focus on the build.