scss-scaffolder-cli

SCSS Scaffolder CLI ✨

A CLI tool for scaffolding SCSS folder and files based on the 7/1 architecture pattern.

Installation 📦

To install the CLI tool globally, run:

npm install -g scss-scaffolder-cli

Usage 🚀

To run the CLI tool, use the following command:

scss-cli

You will be prompted to enter the destination folder and select the folders you want to include in your SCSS structure.

Alternatively, you can use npx to run the CLI tool without installing it globally:

npx scss-cli

Options ⚙️

• destination: The root folder for the SCSS structure (default: ./scss).
• folders: The folders to include in your SCSS structure. You can select from the following options:
  • abstracts
  • base
  • components
  • layout
  • pages
  • themes
  • vendors

Example 💡

scss-cli

Follow the prompts to configure your SCSS structure. The tool will create the selected folders and files in the specified destination.

Example Directory Structure

scss/
├── scaffold-main.scss
├── abstracts/
│   ├── _variables.scss
│   ├── _mixins.scss
│   └── _functions.scss
├── base/
│   ├── _reset.scss
│   └── _typography.scss
├── components/
│   ├── _buttons.scss
│   └── _cards.scss
├── layout/
│   ├── _header.scss
│   ├── _footer.scss
│   └── _grid.scss
├── pages/
├── themes/
└── vendors/

License 📜

This project is licensed under the GPL-3.0-or-later License.