Skip to content

A static code analysis tool for detecting code smells and best practice violations in Vue.js and Nuxt.js projects

License

Notifications You must be signed in to change notification settings

David-Pena/vue-mess-detector

 
 

Repository files navigation

Vue Mess Detector

A static code analysis tool for detecting code smells and best practice violations in Vue.js and Nuxt.js projects.

Contributors

rrd
rrd
David-Pena
David Pena

Installation

As a vscode extension

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install WebMania.vue-mess-detector

More info: https://marketplace.visualstudio.com/items?itemName=WebMania.vue-mess-detector

From npm registry

# using pnpm
pnpm add vue-mess-detector -D

# using yarn
yarn add vue-mess-detector -D

# using npm
npm install vue-mess-detector --save-dev

# using bun
bun add @rrd/vue-mess-detector --dev

From JSR registry

# using deno
deno add @rrd/vue-mess-detector

# using pnpm
pnpm dlx jsr add @rrd/vue-mess-detector -D

# using yarn
yarn dlx jsr add @rrd/vue-mess-detector -D

# using npm
npx jsr add @rrd/vue-mess-detector --save-dev

# using bun
bunx jsr add @rrd/vue-mess-detector --dev

Usage

If you want to analyze your full project directory.

npx vue-mess-detector analyze

If you want to analyze only your src/components directory.

npx vue-mess-detector analyze ./src/components

If you want to ignore some rulesets add the --ignore flag with comma separated list of rulesets to ignore.

npx vue-mess-detector analyze ./src --ignore=vue-caution,rrd

If you want to apply only some rulesets add the --apply flag with comma separated list of rulesets to apply.

npx vue-mess-detector analyze ./src --apply=vue-caution,rrd

Example output

Output Image

Documentation

👉 For more information, see the documentation.

How to contribute?

See CONTRIBUTING.md file.

About

A static code analysis tool for detecting code smells and best practice violations in Vue.js and Nuxt.js projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 96.5%
  • Shell 3.0%
  • JavaScript 0.5%