Vue-code-style-tools NPM

VUE-CODE-STYLE-TOOLS

This is an opinionated mrm preset aims to enforce code style of vue projects. It consists of a serires of tasks to install the featuring packages. The tasks are sequential and are not independent, so it is the only way to use this package as a preset to make it work.

Issues/PRs are welcomed.

Featuring Packages

Eslint
Prettier
husky
Lint-staged
Commitlint
eslint-plugin-vue

Prerequisite

Your project must have been inited as a .git repositry.
npm is required.

Cautions

It may cause peerDependecies conflicts. You should better resovle the conflicts first, or you can just undo all the changes which is easy in a git repositry. So don't you worry, keep calm, and take your time.

How to use

cd /your-project
npx mrm setup --preset vue-code-style-tools

If you share your project with others, you should push the changes to your remote repositry and then tell your team to run npm run prepare.

Recommended Workflow

change your code
git add <changed files>
git commit -m "your message here"

You can also use "npx lint-staged" for tht last step instead if you are not ready to commit yet.

If you meet any failed error, interpret the message seriously and then fix it. It couldn't be better to look up the error in its respective offical documents.