vmd action

Vue Mess Detektoraktion

Ein Tool zur statischen Codeanalyse zum Erkennen von Codegerüchen und Verstößen zwischen den Best -Practice -Verstößen in VUE.JS- und NUXT.JS -Projekten.

Integrieren Sie den Vue -Messdetektor problemlos in Ihre CI -Pipeline, um Pull -Anforderungswarnungen zu erhalten und mühelos Abzeichen anzuzeigen.

Anfrage anrufen Demo

Installation

Tipp

Referenz: So verwenden Sie Vue Messdetektor

Sie können diese Aktion als Schritt in Ihrem Workflow für Github -Aktionen hinzufügen. Hier ist ein Beispiel dafür, wie man es benutzt:

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]

Garn

 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]

Brötchen

 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] 

Verwendung

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

Eingänge

Tipp

Sie finden die Liste der Eingänge und deren Beschreibungen in der Datei Action.yml.

Eingang	Beschreibung	Erforderlich	Standard
Github-Token	Github -Token für die Stellungnahme zu Pull -Anfragen	false	github.token
Version	Version von Vue Mess Detektor	true	latest
SkipInstall	Überspringen Sie die Installation von Vue Messdetektor	true	false
Skipbots	Überspringen Sie die Laufanalyse auf Pull -Anfragen von Bots	true	true
kommentiert	Kommentar zu Pull -Anfragen?	true	true
Packagemanager	Paketmanager zu verwenden	false	(Erkennen)
Runargs	Argumente, die an Vue Mess Detektor geleitet werden müssen	false	--group=file
Einstiegspunkt	Einstiegspunkt für Vue Messdetektor	false	./
srcdir	Quellverzeichnis zur Analyse	true	src/
Löschungen	Alte Berichtskommentare zu Pull -Anfragen löschen?	false	false
relativemode	Vergleichen Sie den aktuellen Zweig mit dem Ziel (nur PR)	true	true

Beitragen

Wir begrüßen Beiträge zu diesem Projekt! Bitte lesen Sie unseren Beitragsführer, um weitere Informationen zum Beitrag zu erhalten.

Wenn Sie dieses Projekt als nützlich empfunden haben, sollten Sie es auf GitHub einsetzen. Dies hilft, das Bewusstsein für das Projekt zu verbreiten und ist eine großartige Möglichkeit, Ihre Unterstützung zu zeigen!

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.