vmd action

Ação do detector de bagunça vue

Uma ferramenta de análise de código estático para detectar cheiros de código e violações de práticas recomendadas nos projetos Vue.js e Nuxt.js.

Integrar facilmente o Vue Mess Detector no seu pipeline de CI para receber alertas de solicitação de puxar e exibir crachás sem esforço.

Pull Solicy Demo

Instalação

Dica

Referência: Como usar o Vue Mess Detector

Você pode adicionar essa ação como uma etapa no fluxo de trabalho das ações do seu GitHub. Aqui está um exemplo de como usá -lo:

PNPM

 name : VMD Analysis

on :
  workflow_dispatch :
  pull_request :
    branches :
      - main
  push :
    branches :
      - main

permissions :
  contents : read
  pull-requests : write

jobs :
  detect-mess :
    runs-on : ubuntu-latest
    name : Detect Vue Mess
    steps :
      - name : Checkout
        uses : actions/checkout@v4

      - uses : pnpm/action-setup@v4
        name : Install pnpm
        with :
          run_install : false
          version : ' latest ' # delete this line if you have packageManager defined in package.json

      - name : Install Node.js
        uses : actions/setup-node@v4
        with :
          node-version : 20
          cache : ' pnpm '

      - name : Vue Mess Detector Analysis
        uses : brenoepics/[email protected]

npm

 name : VMD Analysis

on :
  workflow_dispatch :
  pull_request :
    branches :
      - main
  push :
    branches :
      - main

permissions :
  contents : read
  pull-requests : write

jobs :
  detect-mess :
    runs-on : ubuntu-latest
    name : Detect Vue Mess
    steps :
      - name : Checkout
        uses : actions/checkout@v4

      - name : Install Node.js
        uses : actions/setup-node@v4
        with :
          node-version : 20

      - name : Vue Mess Detector Analysis
        uses : brenoepics/[email protected]

fio

 name : VMD Analysis

on :
  workflow_dispatch :
  pull_request :
    branches :
      - main
  push :
    branches :
      - main

permissions :
  contents : read
  pull-requests : write

jobs :
  detect-mess :
    runs-on : ubuntu-latest
    name : Detect Vue Mess
    steps :
      - name : Checkout
        uses : actions/checkout@v4

      - name : Install Node.js
        uses : actions/setup-node@v4
        with :
          node-version : 20
          cache : ' yarn '

      - name : Vue Mess Detector Analysis
        uses : brenoepics/[email protected]

BUN

 name : VMD Analysis

on :
  workflow_dispatch :
  pull_request :
    branches :
      - main
  push :
    branches :
      - main

permissions :
  contents : read
  pull-requests : write

jobs :
  detect-mess :
    runs-on : ubuntu-latest
    name : Detect Vue Mess
    steps :
      - name : Checkout
        uses : actions/checkout@v4

      - name : Install Bun
        uses : oven-sh/setup-bun@v2
        with :
          bun-version : ' latest '

      - name : Vue Mess Detector Analysis
        uses : brenoepics/[email protected] 

Uso

Veja Action.yml

- uses : brenoepics/[email protected]
  with :
    # 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)
    github-token : ' '

    # Version of Vue Mess Detector to use. This can be a specific version number
    # or 'latest' to use the most recent version available.
    version : ' '

    # 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.
    skipInstall : ' '

    # If set to 'true', the action will skip running analysis on pull requests
    # created by bots. This can help reduce unnecessary analysis runs.
    skipBots : ' '

    # 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.
    commentsEnabled : ' '

    # 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.
    packageManager : ' '

    # Additional arguments to pass to Vue Mess Detector when running the analysis.
    # This can be used to customize the behavior of the analysis.
    runArgs : ' '

    # 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.
    entryPoint : ' '

    # 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.
    srcDir : ' '

    # 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.
    deleteOldComments : ' '

    # 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.
    relativeMode : ' ' 

Entradas

Dica

Você pode encontrar a lista de entradas e suas descrições no arquivo action.yml.

Entrada	Descrição	Obrigatório	Padrão
Github-Token	Token do Github por comentar sobre solicitações de puxar	false	github.token
versão	Versão do Vue Mess Detector	true	latest
skipinstall	Pule a instalação do Vue Mess Detector	true	false
skipbots	Pule a análise de execução em solicitações de pull de bots	true	true
Comentários esabled	Comentar sobre solicitações de puxão?	true	true
PackageManager	Gerenciador de pacotes para usar	false	(detectar)
RUNARGS	Argumentos para passar para o Vue Mess Detector	false	--group=file
Ponto de entrada	Ponto de entrada para o detector de bagunça de vue	false	./
srcdir	Diretório de origem para analisar	true	src/
DeleteoldComments	Excluir comentários antigos do relatório sobre solicitações de tração?	false	false
RelativEMode	Compare o ramo atual com o alvo (somente PR)	true	true

Contribuindo

Congratulamo -nos com contribuições para este projeto! Leia nosso guia contribuinte para obter mais informações sobre como contribuir.

Se você achou esse projeto útil, considere dar um no Github. Isso ajuda a espalhar a conscientização do projeto e é uma ótima maneira de mostrar seu apoio!

Licença

Este projeto está licenciado sob a licença do MIT.