vmd action

Action du détecteur Vue Mess

Un outil d'analyse de code statique pour détecter les odeurs de code et les violations des meilleures pratiques dans les projets Vue.js et nuxt.js.

Intégrez facilement le détecteur Vue Mess dans votre pipeline CI pour recevoir des alertes de demande de traction et afficher les badges sans effort.

Demo de demande de tirage

Installation

Conseil

Référence: comment utiliser le détecteur Vue Mess

Vous pouvez ajouter cette action comme étape de votre flux de travail GitHub Actions. Voici un exemple de la façon de l'utiliser:

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]

fil

 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]

chignon

 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] 

Usage

Voir 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 : ' ' 

Entrées

Conseil

Vous pouvez trouver la liste des entrées et leurs descriptions dans le fichier Action.yml.

Saisir	Description	Requis	Défaut
gitub	Jeton GitHub pour commenter les demandes de traction	false	github.token
version	Version du détecteur Vue Mess	true	latest
skipinstall	Sauter l'installation du détecteur Vue Mess	true	false
skipbots	Sauter une analyse en cours d'exécution sur les demandes de traction des bots	true	true
commentaires	Commenter les demandes de traction?	true	true
packagemanager	Gestionnaire de packages à utiliser	false	(détecter)
runargs	Arguments à passer au détecteur Vue Mess	false	--group=file
point d'entrée	Point d'entrée pour le détecteur Vue Mess	false	./
srcdir	Répertoire source pour analyser	true	src/
Deleteoldcomments	Supprimer l'ancien rapport des commentaires sur les demandes de traction?	false	false
relativeMode	Comparez la branche actuelle avec la cible (PR uniquement)	true	true

Contributif

Nous saluons les contributions à ce projet! Veuillez lire notre guide de contribution pour plus d'informations sur la façon de contribuer.

Si vous avez trouvé ce projet utile, veuillez envisager de lui donner un sur GitHub. Cela aide à diffuser la conscience du projet et est un excellent moyen de montrer votre soutien!

Licence

Ce projet est autorisé sous la licence du MIT.