generator-scaff
v0.2.1
Published
scaffolding generator
Downloads
6
Readme
🚀 What makes:
- ⚙️ Configure eslint, standard, and prettier.
- 🗃️ Configure paths for absolute imports.
Usage:
install yeoman:
npm install -g yo
install generator:
npm install -g generator-scaff
use the scaffolding generator:
yo scaff:vite
If you want to avoid overwrite questions you can use the force
flag:
yo scaff:vite --force
📚 How to use:
Acctually, those are the options you can use. | Option | Description | | ------ | ----------- | | ts | Project with TypeScript | | js | Project with JavaScript | | fix | Run lint and format commands |
You can define options with flags or prompts:
yo scaff:vite --js --fix
If not provides any option, the scaffolding generator will ask you to provide them.
# Language option
Choose a language:
JavaScript
TypeScript
# Fix option
Would you like run lint and format your code? (Y/n)
If you decide not to use fix
option, remember to run:
npm run lint && npm run format
🛠️ Working with:
- ⚡ Vitejs on Reactjs Projects with JavaScript or TypeScript.
📦 Packages:
| Package | Version | | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | @typescript-eslint/eslint-plugin (Only with TypeScript flag) | | | @typescript-eslint/parser (Only with TypeScript flag) | | | eslint | | | standard | | | prettier | | | eslint-config-prettier | | | eslint-config-standard | | | eslint-plugin-import | | | eslint-plugin-n | | | eslint-plugin-promise | | | eslint-plugin-react | | | eslint-plugin-simple-import-sort | | | vite-tsconfig-paths | |
Ideas:
Add more options to configure the scaffolding generator, for example:
external
to generate eslint and prettier configs on external files.eslintrc.json
oreslintrc.js
.prettierrc
with-tailwind
to install and generate tailwind configs.- Using
prettier-plugin-tailwindcss
plugin.
- Using
Add more scaffolding generators, for example:
scaff:next
to scaffold a nextjs project with same options.scaff:remix
to scaffold a remix project with same options.scaff:node
to scaffold a vitejs project with same options.