brenoepics/vmd-action
A static code analysis tool for detecting code smells and best practice violations in Vue.js and Nuxt.js projects.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Apr 2, 2025
- License
- MIT
Pinned Snippet
uses: brenoepics/vmd-action@05ed0c6f0824f63816ee22aeea4460cd0ef1a25e # v0.0.7tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | Personal access token (PAT) used to fetch the repository. The PAT is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the PAT. We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | no | ${{ github.token }} |
| version | Version of Vue Mess Detector to use. This can be a specific version number or 'latest' to use the most recent version available. | yes | latest |
| skipInstall | If set to 'true', the action will skip the installation of Vue Mess Detector. This can be useful if Vue Mess Detector is already installed in your environment. | yes | false |
| skipBots | If set to 'true', the action will skip running analysis on pull requests created by bots. This can help reduce unnecessary analysis runs. | yes | true |
| commentsEnabled | If set to 'true', the action will post comments on pull requests with the results of the analysis. If set to 'false', no comments will be posted. | yes | true |
| packageManager | The package manager to use for installing dependencies. Supported values are 'npm', 'yarn', 'pnpm', and 'bun'. If not specified, the action will attempt to detect the package manager based on the lock file present in the repository. | no | — |
| runArgs | Additional arguments to pass to Vue Mess Detector when running the analysis. This can be used to customize the behavior of the analysis. | no | --group=file |
| entryPoint | The entry point for Vue Mess Detector. This is the directory where the analysis will start. If not specified, the current directory will be used. | no | — |
| srcDir | The source directory to analyze. This should be the path to the directory containing the source code you want to analyze. If not specified, 'src/' will be used. | yes | src/ |
| deleteOldComments | If set to 'true', the action will delete old comments on pull requests before posting new ones. This can help keep the comment section clean. | no | false |
| relativeMode | If set to 'true', the action will generate a report comparing the current branch with the target branch. This can be useful for identifying changes introduced in a pull request. | yes | true |
Outputs
no outputs