Vue 3 Formatter Initializer

This repository provides a formatter setup script and configuration files for Vue 3 projects. It includes settings for ESLint, Prettier, and Stylelint.

Installation as npm Package

Instead of cloning and setting up manually, you can now install this tool directly from npm:

npm install -g vue3-formatter-initializer

We recommend installing this package globally so that it can be used across your system:

Usage as npm Package

After installing globally, navigate to your Vue 3 project directory and simply run:

vue3-formatter-initializer /path/to/vue3-project # default '.'

This will automatically set up ESLint, Prettier, and Stylelint configurations for your Vue 3 project.

Contents

• vue3-formatter-initializer: Script to initialize formatter in Vue 3 project.
• .eslintrc.json: Configuration file for ESLint.
• .prettierrc.json: Configuration file for Prettier.
• .stylelintrc.json: Configuration file for Stylelint.
• shims.d.ts: File to resolve type errors in main.ts.

Manual Usage

1. Clone this repository.

   cd ~

   git clone git@github.com:aose-yuu/vue3-formatter-initializer.git

2. Add the script's path to your .zshrc as an environment variable:

   export PATH="$HOME/vue3-formatter-initializer:$PATH"

   Remember to reload your .zshrc or restart your terminal session for the changes to take effect.

3. Execute the script by specifying the directory path of your project.

   init-vue3-formatter /path/to/vue3-project

Happy coding and enjoy the streamlined formatter setup!