vmd action

عمل الكشف عن الفوضى VUE

أداة تحليل الكود الثابتة لاكتشاف الروائح الكود وأفضل انتهاكات الممارسات في مشاريع Vue.js و Nuxt.js.

دمج كاشف Vue Mess بسهولة في خط أنابيب 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	true	false
Skipbots	تخطي تحليل التشغيل على طلبات السحب من الروبوتات	true	true
CommentEnabled	التعليق على طلبات السحب؟	true	true
Packagemanager	مدير الحزمة لاستخدامه	false	(يكشف)
Runargs	حجج لتمريرها إلى Vue Mess Detector	false	--group=file
نقطة الدخول	نقطة دخول للكشف عن فوضى Vue	false	./
srcdir	دليل المصدر للتحليل	true	src/
DeleteoldComments	حذف تعليقات التقرير القديم على طلبات السحب؟	false	false
RelativeMode	قارن الفرع الحالي بالهدف (PR فقط)	true	true

المساهمة

نرحب بالمساهمات في هذا المشروع! يرجى قراءة دليل المساهمة لدينا لمزيد من المعلومات حول كيفية المساهمة.

إذا وجدت هذا المشروع مفيدًا ، فيرجى التفكير في إعطائه على Github. هذا يساعد على نشر الوعي بالمشروع وهو وسيلة رائعة لإظهار دعمك!

رخصة

هذا المشروع مرخص بموجب ترخيص معهد ماساتشوستس للتكنولوجيا.