vue-mess-detector/README.md

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

# Vue Mess Detector

A comprehensive code analysis and quality assessment tool that provides actionable insights into code health, helping developers identify and resolve potential issues in Vue.js and Nuxt.js projects.

If you like this project, please consider giving it a star ⭐️

## 👥 Core Team

<table>
  <tr>
    <td align="center" style="border: none;">
      <a href="https://github.com/rrd108">
        <img src="https://github.com/rrd108.png?size=100" width="100px;" alt="rrd"/>
        <br />
        <sub><b>rrd</b></sub>
      </a>
    </td>
    <td align="center" style="border: none;">
      <a href="https://github.com/David-Pena">
        <img src="https://github.com/David-Pena.png?size=100" width="100px;" alt="David-Pena"/>
        <br />
        <sub><b>David Pena</b></sub>
      </a>
    </td>
  </tr>
</table>

## ⬇️ Installation

```bash
npm install vue-mess-detector --save-dev
```


## 📦 Integrations

- [Github Action](https://vue-mess-detector.webmania.cc/integrations/vmd-action.html) 
- [Nuxt Devtools](https://github.com/rrd108/vue-mess-detector-nuxt-devtools)
- [Vscode Extension](https://marketplace.visualstudio.com/items?itemName=WebMania.vue-mess-detector)
- Vue Devtools (in progress)
- [Webstorm](https://github.com/rrd108/vue-mess-detector/issues/110) (confirmed)
- ESLint plugin (planned) [Share your thoughts](https://github.com/rrd108/vue-mess-detector/issues/331)

## ⚙️ Usage

Basic usage:

```bash
npx vue-mess-detector analyze [path] [--flags]
```

If you want to store your flags in a configuration file, you can create a `.config/vue-mess-detector.json` file in the root of your project.

## 📚 Documentation

> 👉 For more information, see the [documentation](https://vue-mess-detector.webmania.cc/).

## 👥 Discord Server

👉 Join our [discord server](https://discord.gg/nXKwzk97jn)

## 🤝 How to contribute?

See [CONTRIBUTING.md](https://github.com/rrd108/vue-mess-detector/blob/main/CONTRIBUTING.md) file.