vmd actionダウンロード-VMD vmd actionソースコードのダウンロード

vmd action

その他のカテゴリー

v0.0.7

ダウンロード

Vue Mess Detectorアクション

Vue.JSおよびnuxt.JSプロジェクトでコードの臭いとベストプラクティス違反を検出するための静的コード分析ツール。

Vue Mess DetectorをCIパイプラインに簡単に統合して、プルリクエストアラートを受け取り、バッジを簡単に表示します。

リクエストデモをプルします

インストール

ヒント

参照：Vue Mess Detectorの使用方法

このアクションをGitHubアクションワークフローのステップとして追加できます。使用方法の例は次のとおりです。

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]

糸

 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]

パン

 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]

使用法

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

入力

ヒント

Action.ymlファイルに入力のリストとその説明を見つけることができます。

入力	説明	必須	デフォルト
github-token	プルリクエストについてコメントするためのGithubトークン	`false`	`github.token`
バージョン	Vue Mess Detectorのバージョン	`true`	`latest`
SkipInstall	Vue Mess Detectorのインストールをスキップします	`true`	`false`
スキップボット	ボットからのプルリクエストの実行ラン分析をスキップします	`true`	`true`
ContumentEnabled	プルリクエストにコメントしますか？	`true`	`true`
PackageManager	使用するパッケージマネージャー	`false`	（検出する）
runargs	Vue Mess Detectorに合格する議論	`false`	`--group=file`
エントリポイント	Vue Mess Detectorのエントリポイント	`false`	`./`
srcdir	分析するソースディレクトリ	`true`	`src/`
DeleteOldComments	プルリクエストに関する古いレポートのコメントを削除しますか？	`false`	`false`
relativeMode	現在のブランチをターゲットと比較します（PRのみ）	`true`	`true`