vmd action
v0.0.7
一種用於檢測代碼氣味和最佳實踐違規的靜態代碼分析工具。
輕鬆將VUE MESS探測器集成到您的CI管道中,以接收拉動請求警報並毫不費力地顯示徽章。

提示
參考:如何使用VUE MESS探測器
您可以將此操作添加為GitHub操作工作流程中的一步。這是如何使用它的示例:
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] 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探測器的版本 | true | latest |
| 跳過 | 跳過VUE MESS探測器的安裝 | true | false |
| 跳過 | 跳過機器人的拉力請求分析 | true | true |
| 評論已找到 | 評論拉請求? | true | true |
| PackageManager | 使用的軟件包管理器 | false | (探測) |
| Runargs | 爭論傳遞給VUE MESS探測器 | false | --group=file |
| 入口點 | VUE MESS探測器的入口點 | false | ./ |
| srcdir | 來源目錄進行分析 | true | src/ |
| 刪除 | 刪除有關拉請求的舊報告評論? | false | false |
| RelativeMode | 比較當前分支與目標(僅PR) | true | true |
我們歡迎對這個項目的貢獻!請閱讀我們的貢獻指南,了解有關如何貢獻的更多信息。
如果您發現此項目有用,請考慮在GitHub上提供一個。這有助於傳播對項目的認識,是表達您支持的好方法!
該項目已根據MIT許可獲得許可。