vmd action
v0.0.7
vue.js 및 nuxt.js 프로젝트의 코드 냄새 및 모범 사례 위반을 감지하기위한 정적 코드 분석 도구.
VUE Mess Detector를 CI 파이프 라인에 쉽게 통합하여 풀 요청 경고를 받고 배지를 쉽게 표시합니다.

팁
참조 : Vue Mess Detector 사용 방법
이 작업을 GitHub Action 워크 플로의 단계로 추가 할 수 있습니다. 사용 방법의 예는 다음과 같습니다.
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 Detector의 버전 | true | latest |
| skipinstall | VUE Mess Detector의 설치를 건너 뜁니다 | true | false |
| 건너 뛰기 | 봇의 풀 요청에서 실행 분석을 건너 뜁니다 | true | true |
| 댓글이 적용되었습니다 | 풀 요청에 대한 의견? | true | true |
| Packagemanager | 사용할 패키지 관리자 | false | (감지하다) |
| runargs | Vue Mess Detector에게 전달되는 인수 | false | --group=file |
| EntryPoint | Vue Mess Detector의 진입 점 | false | ./ |
| srcdir | 분석 할 소스 디렉토리 | true | src/ |
| 삭제됩니다 | 풀 요청에 대한 오래된 보고서 댓글을 삭제 하시겠습니까? | false | false |
| 상대성 모드 | 현재 지점을 대상과 비교하십시오 (PR 만 해당) | true | true |
우리는이 프로젝트에 대한 기여를 환영합니다! 기여 방법에 대한 자세한 내용은 기고 안내서를 읽으십시오.
이 프로젝트가 유용하다고 생각되면 Github에 제공하는 것을 고려하십시오. 이것은 프로젝트에 대한 인식을 전하는 데 도움이되며 지원을 보여주는 좋은 방법입니다!
이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다.