{"id":23596504,"url":"https://github.com/brenoepics/vmd-action","last_synced_at":"2025-05-08T00:54:13.911Z","repository":{"id":268526223,"uuid":"861468801","full_name":"brenoepics/vmd-action","owner":"brenoepics","description":"Easily integrate Vue Mess Detector into your CI pipeline to receive pull request alerts and display badges effortlessly.","archived":false,"fork":false,"pushed_at":"2025-05-05T00:20:23.000Z","size":13592,"stargazers_count":8,"open_issues_count":8,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-08T00:54:07.286Z","etag":null,"topics":["code-quality","collaborate","github","static-analysis"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brenoepics.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-23T00:41:15.000Z","updated_at":"2025-04-02T12:07:10.000Z","dependencies_parsed_at":"2024-12-17T10:36:50.228Z","dependency_job_id":null,"html_url":"https://github.com/brenoepics/vmd-action","commit_stats":null,"previous_names":["brenoepics/vmd-action"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brenoepics%2Fvmd-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brenoepics%2Fvmd-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brenoepics%2Fvmd-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brenoepics%2Fvmd-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brenoepics","download_url":"https://codeload.github.com/brenoepics/vmd-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252978738,"owners_count":21834915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-quality","collaborate","github","static-analysis"],"created_at":"2024-12-27T10:12:42.919Z","updated_at":"2025-05-08T00:54:13.889Z","avatar_url":"https://github.com/brenoepics.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- This file was generated from a .prp --\u003e\n\u003cdiv align=\"center\"\u003e\n\n# Vue Mess Detector Action\n\n_A static code analysis tool for detecting code smells and best practice\nviolations in Vue.js and Nuxt.js projects._\n\n![Release](https://img.shields.io/github/v/release/brenoepics/vmd-action?include_prereleases\u0026sort=semver\u0026logo=github)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brenoepics/vmd-action/ci.yml?logo=github)\n![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/brenoepics/vmd-action?logo=github)\n\u003c/div\u003e\n\nEasily integrate [Vue Mess Detector](https://github.com/rrd108/vue-mess-detector) into your CI pipeline to receive pull\nrequest alerts and display badges effortlessly.\n\n\u003cdetails\u003e\n\u003csummary\u003ePull Request Demo\u003c/summary\u003e\n\n![img.png](preview.png)\n\n\u003c/details\u003e\n\n## Installation\n\n\u003e [!TIP]\n\u003e Reference: [How to Use Vue Mess Detector](https://vue-mess-detector.webmania.cc/)\n\nYou can add this action as a step in your [GitHub Actions](https://github.com/features/actions)\nworkflow.\nHere's an example of how to\nuse it:\n\n\u003cdetails\u003e\n\u003csummary\u003epnpm\u003c/summary\u003e\n\n```yaml\nname: VMD Analysis\n\non:\n  workflow_dispatch:\n  pull_request:\n    branches:\n      - main\n  push:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  detect-mess:\n    runs-on: ubuntu-latest\n    name: Detect Vue Mess\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - uses: pnpm/action-setup@v4\n        name: Install pnpm\n        with:\n          run_install: false\n          version: 'latest' # delete this line if you have packageManager defined in package.json\n\n      - name: Install Node.js\n        uses: actions/setup-node@v4\n        with:\n          node-version: 20\n          cache: 'pnpm'\n\n      - name: Vue Mess Detector Analysis\n        uses: brenoepics/vmd-action@v0.0.7\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003enpm\u003c/summary\u003e\n\n```yaml\nname: VMD Analysis\n\non:\n  workflow_dispatch:\n  pull_request:\n    branches:\n      - main\n  push:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  detect-mess:\n    runs-on: ubuntu-latest\n    name: Detect Vue Mess\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Install Node.js\n        uses: actions/setup-node@v4\n        with:\n          node-version: 20\n\n      - name: Vue Mess Detector Analysis\n        uses: brenoepics/vmd-action@v0.0.7\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eyarn\u003c/summary\u003e\n\n```yaml\nname: VMD Analysis\n\non:\n  workflow_dispatch:\n  pull_request:\n    branches:\n      - main\n  push:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  detect-mess:\n    runs-on: ubuntu-latest\n    name: Detect Vue Mess\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Install Node.js\n        uses: actions/setup-node@v4\n        with:\n          node-version: 20\n          cache: 'yarn'\n\n      - name: Vue Mess Detector Analysis\n        uses: brenoepics/vmd-action@v0.0.7\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ebun\u003c/summary\u003e\n\n```yaml\nname: VMD Analysis\n\non:\n  workflow_dispatch:\n  pull_request:\n    branches:\n      - main\n  push:\n    branches:\n      - main\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  detect-mess:\n    runs-on: ubuntu-latest\n    name: Detect Vue Mess\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Install Bun\n        uses: oven-sh/setup-bun@v2\n        with:\n          bun-version: 'latest'\n\n      - name: Vue Mess Detector Analysis\n        uses: brenoepics/vmd-action@v0.0.7\n```\n\n\u003c/details\u003e\n\n## Usage\n\nSee [action.yml](action.yml)\n\n\u003c!-- start usage --\u003e\n```yaml\n- uses: brenoepics/vmd-action@v0.0.7\n  with:\n    # Personal access token (PAT) used to fetch the repository. The PAT is\n    # configured with the local git config, which enables your scripts to run\n    # authenticated git commands. The post-job step removes the PAT.\n    #\n    # We recommend using a service account with the least permissions necessary.\n    # Also when generating a new PAT, select the least scopes necessary.\n    #\n    # [Learn more about creating and using encrypted\n    # secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)\n    github-token: ''\n\n    # Version of Vue Mess Detector to use. This can be a specific version number\n    # or 'latest' to use the most recent version available.\n    version: ''\n\n    # If set to 'true', the action will skip the installation of Vue Mess Detector.\n    # This can be useful if Vue Mess Detector is already installed in your environment.\n    skipInstall: ''\n\n    # If set to 'true', the action will skip running analysis on pull requests\n    # created by bots. This can help reduce unnecessary analysis runs.\n    skipBots: ''\n\n    # If set to 'true', the action will post comments on pull requests with the\n    # results of the analysis. If set to 'false', no comments will be posted.\n    commentsEnabled: ''\n\n    # The package manager to use for installing dependencies. Supported values\n    # are 'npm', 'yarn', 'pnpm', and 'bun'. If not specified, the action will\n    # attempt to detect the package manager based on the lock file present in\n    # the repository.\n    packageManager: ''\n\n    # Additional arguments to pass to Vue Mess Detector when running the analysis.\n    # This can be used to customize the behavior of the analysis.\n    runArgs: ''\n\n    # The entry point for Vue Mess Detector. This is the directory where the\n    # analysis will start. If not specified, the current directory will be used.\n    entryPoint: ''\n\n    # The source directory to analyze. This should be the path to the directory\n    # containing the source code you want to analyze. If not specified, 'src/'\n    # will be used.\n    srcDir: ''\n\n    # If set to 'true', the action will delete old comments on pull requests\n    # before posting new ones. This can help keep the comment section clean.\n    deleteOldComments: ''\n\n    # If set to 'true', the action will generate a report comparing the current\n    # branch with the target branch. This can be useful for identifying changes\n    # introduced in a pull request.\n    relativeMode: ''\n```\n\u003c!-- end usage --\u003e\n\n## Inputs\n\n\u003e [!TIP]\n\u003e You can find the list of inputs and their descriptions in the [action.yml](action.yml) file.\n\n| Input             | Description                                          | Required | Default                                                 |\n|-------------------|------------------------------------------------------|----------|---------------------------------------------------------|\n| github-token      | GitHub token for commenting on pull requests         | `false`  | `github.token`                                          |\n| version           | Version of Vue Mess Detector                         | `true`   | [`latest`](https://github.com/rrd108/vue-mess-detector) |\n| skipInstall       | Skip the installation of Vue Mess Detector           | `true`   | `false`                                                 |\n| skipBots          | Skip running analysis on pull requests from bots     | `true`   | `true`                                                  |\n| commentsEnabled   | Comment on Pull requests?                            | `true`   | `true`                                                  |\n| packageManager    | Package manager to use                               | `false`  | (detect)                                                |\n| runArgs           | Arguments to pass to Vue Mess Detector               | `false`  | `--group=file`                                          |\n| entryPoint        | Entry point for Vue Mess Detector                    | `false`  | `./`                                                    |\n| srcDir            | Source directory to analyze                          | `true`   | `src/`                                                  |\n| deleteOldComments | Delete old report comments on pull requests?         | `false`  | `false`                                                 |\n| relativeMode      | Compare the current branch with the target (PR only) | `true`   | `true`                                                  |\n\n## Contributing\n\nWe welcome contributions to this project! Please read our [Contributing Guide](CONTRIBUTING.md) for more information on\nhow to contribute.\n\nIf you've found this project useful, please consider giving it a ⭐ on GitHub.\nThis helps to spread the awareness of the\nproject and is a great way to show your support!\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrenoepics%2Fvmd-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrenoepics%2Fvmd-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrenoepics%2Fvmd-action/lists"}