# 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 Latest version **1.0.0** (published 2021-06-23) · MIT license · 0 weekly downloads ## Install ```sh npm install stylelintrc-generator pnpm add stylelintrc-generator yarn add stylelintrc-generator bun add stylelintrc-generator ``` Provides the command `generate-stylelintrc`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2021-06-23 | | First published | 2021-06-22 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Deeshan Sharma | | Maintainers | deeshansharma | | Keywords | stylelint, stylelintrc, generator, javascript, typescript, stylelint-config, stylelint-plugin, stylelintconfig, stylelintrc-generator | ## Links - npm: https://www.npmjs.com/package/stylelintrc-generator - Repository: https://github.com/DeeshanSharma/stylelintrc-generator - Homepage: https://github.com/DeeshanSharma/stylelintrc-generator#readme - Issues: https://github.com/DeeshanSharma/stylelintrc-generator/issues - npm.io page: https://npm.io/package/stylelintrc-generator ## Dependencies (7) - [chalk](https://npm.io/package/chalk.md) ^4.1.1 - [clear](https://npm.io/package/clear.md) ^0.1.0 - [execa](https://npm.io/package/execa.md) ^5.1.1 - [listr](https://npm.io/package/listr.md) ^0.14.3 - [figlet](https://npm.io/package/figlet.md) ^1.5.0 - [inquirer](https://npm.io/package/inquirer.md) ^8.1.1 - [center-align](https://npm.io/package/center-align.md) ^1.0.1 ## Alternatives - [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads - [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads - [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads - [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads - [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads ## Recent versions - 1.0.0 (latest) — 2021-06-23 - 1.0.0-rc.0 (next) — 2021-06-22 ## 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](https://img.shields.io/npm/v/stylelintrc-generator?color=success&label=npm%20package&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/stylelintrc-generator) ![Status](https://img.shields.io/badge/status-active-success.svg?logo=statuspal&style=for-the-badge) [![GitHub issues](https://img.shields.io/github/issues/DeeshanSharma/stylelintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/stylelintrc-generator/issues) [![GitHub forks](https://img.shields.io/github/forks/DeeshanSharma/stylelintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/stylelintrc-generator/network) [![GitHub stars](https://img.shields.io/github/stars/DeeshanSharma/stylelintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/stylelintrc-generator/stargazers) [![GitHub pull requests](https://img.shields.io/github/issues-pr/DeeshanSharma/stylelintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/stylelintrc-generator/pulls) [![GitHub License](https://img.shields.io/github/license/DeeshanSharma/stylelintrc-generator?color=sucess&logo=gnu%20privacy%20guard&logoColor=white&style=for-the-badge)](https://github.com/DeeshanSharma/stylelintrc-generator/blob/main/LICENSE)

![Project Demo Gif](assets/stylelintrc-generator-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 1. Perfectly compatible with - Scss - CSS - Prettier 1. Ask questions and creates config based on your choice 1. You have complete control over the configuration 1. Checks for package.json file and `npm init -y` if not found 1. Installs all required packages as dev dependency as per the config 1. 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) ```bash 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_ 1. Per project installation ```bash npm i stylelintrc-generator -D or yarn add stylelintrc-generator -D ``` 1. Command to generate RC file ```bash 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 - [@DeeshanSharma](https://www.github.com/DeeshanSharma) - Idea & Initial Work ## 📖 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`](LICENCE) for more information. ## 🧬 Resources - [Stylelint Docs](https://stylelint.io) - [NPM Docs - Creating Node.js modules](https://docs.npmjs.com/creating-node-js-modules) - [Twilio Guide - How to build a CLI with Node.js](https://www.twilio.com/blog/how-to-build-a-cli-with-node-js) ## 🎉 Acknowledgement - [Shields.io](https://shields.io) - [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) - [Chalk](https://github.com/chalk/chalk) - [Listr](https://github.com/SamVerschueren/listr) - [Execa](https://github.com/sindresorhus/execa) - [Center Align](https://github.com/jonschlinkert/center-align) - [Figlet.js](https://github.com/patorjk/figlet.js) - [Clear](https://github.com/bahamas10/node-clear) ## 👋 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. --- _Source: https://npm.io/package/stylelintrc-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._