vmd action
v0.0.7
Alat analisis kode statis untuk mendeteksi bau kode dan pelanggaran praktik terbaik di proyek Vue.js dan Nuxt.js.
Dengan mudah mengintegrasikan Vue Mess Detector ke dalam pipa CI Anda untuk menerima peringatan permintaan tarik dan menampilkan lencana dengan mudah.
Tip
Referensi: Cara Menggunakan Vue Mess Detector
Anda dapat menambahkan tindakan ini sebagai langkah dalam alur kerja tindakan GitHub Anda. Berikut adalah contoh cara menggunakannya:
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] Lihat 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 : ' ' Tip
Anda dapat menemukan daftar input dan deskripsi mereka dalam file Action.yml.
| Masukan | Keterangan | Diperlukan | Bawaan |
|---|---|---|---|
| Github-Token | Token GitHub untuk mengomentari permintaan tarik | false | github.token |
| versi | Versi Detektor Vue Mess | true | latest |
| Skipinstall | Lewati pemasangan detektor kekacauan Vue | true | false |
| Skipbots | Lewati analisis berjalan pada permintaan tarik dari bot | true | true |
| Komentar yang dapat dijalankan | Mengomentari permintaan tarik? | true | true |
| PackageManager | Manajer paket untuk digunakan | false | (Deteksi) |
| runargs | Argumen untuk disampaikan kepada Vue Mess Detector | false | --group=file |
| titik masuk | Titik masuk untuk Vue Mess Detector | false | ./ |
| srcdir | Direktori Sumber untuk Menganalisis | true | src/ |
| DeleteOldComments | Hapus komentar laporan lama tentang permintaan tarik? | false | false |
| Relativemode | Bandingkan cabang saat ini dengan target (hanya PR) | true | true |
Kami menyambut kontribusi untuk proyek ini! Harap baca panduan berkontribusi kami untuk informasi lebih lanjut tentang cara berkontribusi.
Jika Anda menemukan proyek ini bermanfaat, silakan pertimbangkan untuk memberikannya di GitHub. Ini membantu menyebarkan kesadaran proyek dan merupakan cara yang bagus untuk menunjukkan dukungan Anda!
Proyek ini dilisensikan di bawah lisensi MIT.
