From 2ee15c9d4f86a52c53ab320fb052aea7bd103588 Mon Sep 17 00:00:00 2001 From: David-Pena Date: Thu, 10 Oct 2024 01:31:46 -0700 Subject: [PATCH 1/5] feat: add integration item in docs for gh action (#392) --- docs/.vitepress/config.ts | 6 +++++ docs/integrations/vmd-action.md | 40 +++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 docs/integrations/vmd-action.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index f8435771..ede64f86 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -109,6 +109,12 @@ export default defineConfig({ { text: 'eslint-plugin-vue Comparison', link: '/eslint-comparison' }, ], }, + { + text: 'Integrations', + items: [ + { text: 'Github Action', link: '/integrations/vmd-action' }, + ], + }, { items: [ { text: 'Suggested Readings', link: '/suggested-readings' }, diff --git a/docs/integrations/vmd-action.md b/docs/integrations/vmd-action.md new file mode 100644 index 00000000..feded926 --- /dev/null +++ b/docs/integrations/vmd-action.md @@ -0,0 +1,40 @@ +# VMD Action + +Here is an example on how to use it on your workflow using `npm`: + +:::tip + To learn how to use it with `pnpm`, `yarn` or `bun`, and more details about the available options it has, check out the [official documentation](https://github.com/brenoepics/vmd-action). +::: + +```yaml +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/vmd-action@v0.0.6 +``` \ No newline at end of file From 12dde0166d5b429d6ede86f52411b1d2b6a969ae Mon Sep 17 00:00:00 2001 From: David-Pena Date: Thu, 10 Oct 2024 01:35:03 -0700 Subject: [PATCH 2/5] chore(docs): update gh action redirect to our docs (#392) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b6b2ccc1..1996562b 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ npm install vue-mess-detector --save-dev ## 📦 Integrations -- [Github Action](https://github.com/brenoepics/vmd-action) +- [Github Action](https://vue-mess-detector.webmania.cc/integrations/vmd-action.html) - [Nuxt Devtools](https://github.com/rrd108/vue-mess-detector-nuxt-devtools) - [Vscode Extension](https://marketplace.visualstudio.com/items?itemName=WebMania.vue-mess-detector) - Vue Devtools (in progress) From eac86fa0df90294d16aecfe7a9277b616975f82a Mon Sep 17 00:00:00 2001 From: David-Pena Date: Thu, 10 Oct 2024 02:25:49 -0700 Subject: [PATCH 3/5] chore(docs): add other pkg managers to vmd action --- docs/integrations/vmd-action.md | 136 ++++++++++++++++++++++++++++++-- 1 file changed, 131 insertions(+), 5 deletions(-) diff --git a/docs/integrations/vmd-action.md b/docs/integrations/vmd-action.md index feded926..41effc8d 100644 --- a/docs/integrations/vmd-action.md +++ b/docs/integrations/vmd-action.md @@ -1,10 +1,92 @@ # VMD Action -Here is an example on how to use it on your workflow using `npm`: +Here is an example on how to use it on your workflow using `pnpm`, `npm`, `yarn` or `bun`: -:::tip - To learn how to use it with `pnpm`, `yarn` or `bun`, and more details about the available options it has, check out the [official documentation](https://github.com/brenoepics/vmd-action). -::: +
+pnpm + +```yaml +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/vmd-action@v0.0.6 +``` + +
+ +
+npm + +```yaml +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/vmd-action@v0.0.6 +``` + +
+ +
+yarn ```yaml name: VMD Analysis @@ -34,7 +116,51 @@ jobs: uses: actions/setup-node@v4 with: node-version: 20 + cache: 'yarn' - name: Vue Mess Detector Analysis uses: brenoepics/vmd-action@v0.0.6 -``` \ No newline at end of file +``` + +
+ +
+bun + +```yaml +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/vmd-action@v0.0.6 +``` +
+ +:::tip + To learn more details about the available options it has, check out the [official documentation](https://github.com/brenoepics/vmd-action). +::: From a105c1982df3b5ad104de7814124a108bacde440 Mon Sep 17 00:00:00 2001 From: David-Pena Date: Thu, 10 Oct 2024 09:28:26 -0700 Subject: [PATCH 4/5] feat(docs): update vmd action docs with new layout (#392) --- docs/integrations/vmd-action.md | 63 +++++++++++++++------------------ 1 file changed, 29 insertions(+), 34 deletions(-) diff --git a/docs/integrations/vmd-action.md b/docs/integrations/vmd-action.md index 41effc8d..6710ded4 100644 --- a/docs/integrations/vmd-action.md +++ b/docs/integrations/vmd-action.md @@ -1,11 +1,24 @@ # VMD Action -Here is an example on how to use it on your workflow using `pnpm`, `npm`, `yarn` or `bun`: +[![Release](https://img.shields.io/github/v/release/brenoepics/vmd-action?include_prereleases&sort=semver&logo=github)](https://github.com/brenoepics/vmd-action/releases) -
-pnpm +:::tip + To learn more details about the available options it has, check out the [official documentation](https://github.com/brenoepics/vmd-action). +::: + +This GitHub Action integrates VMD into your CI pipeline, providing several key features: + +- **Relative Analysis**: Highlights new issues in pull requests. +- **PR Comments**: Adds detailed comments on detected issues. +- **Action Summary**: Summarizes analysis results in the GitHub Actions tab. + +## Usage + +Here is an example on how to use it on your workflow using `npm`, `pnpm`, `yarn` or `bun`: -```yaml +::: code-group + +```yaml [npm] name: VMD Analysis on: @@ -29,28 +42,16 @@ jobs: - 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/vmd-action@v0.0.6 ``` -
- -
-npm - -```yaml +```yaml [pnpm] name: VMD Analysis on: @@ -74,21 +75,23 @@ jobs: - name: Checkout uses: actions/checkout@v4 + - uses: pnpm/action-setup@v4 // [!code ++:5] + 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' // [!code ++] - name: Vue Mess Detector Analysis uses: brenoepics/vmd-action@v0.0.6 ``` -
- -
-yarn - -```yaml +```yaml [yarn] name: VMD Analysis on: @@ -116,18 +119,13 @@ jobs: uses: actions/setup-node@v4 with: node-version: 20 - cache: 'yarn' + cache: 'yarn' // [!code ++] - name: Vue Mess Detector Analysis uses: brenoepics/vmd-action@v0.0.6 ``` -
- -
-bun - -```yaml +```yaml [bun] name: VMD Analysis on: @@ -151,7 +149,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 - - name: Install Bun + - name: Install Bun // [!code ++:4] uses: oven-sh/setup-bun@v2 with: bun-version: 'latest' @@ -159,8 +157,5 @@ jobs: - name: Vue Mess Detector Analysis uses: brenoepics/vmd-action@v0.0.6 ``` -
-:::tip - To learn more details about the available options it has, check out the [official documentation](https://github.com/brenoepics/vmd-action). ::: From 54b30c936654912f5f2adbce851d4ac93d5c9b63 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 09:37:05 +0000 Subject: [PATCH 5/5] chore(deps): update dependency eslint-plugin-vue to v9.29.0 --- yarn.lock | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/yarn.lock b/yarn.lock index 4af4a66f..6a008c8c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1710,7 +1710,7 @@ birpc@^0.2.17: boolbase@^1.0.0: version "1.0.0" - resolved "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz" + resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e" integrity sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww== brace-expansion@^1.1.7: @@ -1953,7 +1953,7 @@ cross-spawn@^7.0.2, cross-spawn@^7.0.3: cssesc@^3.0.0: version "3.0.0" - resolved "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz" + resolved "https://registry.yarnpkg.com/cssesc/-/cssesc-3.0.0.tgz#37741919903b868565e1c09ea747445cd18983ee" integrity sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg== csstype@^3.1.3: @@ -2332,9 +2332,9 @@ eslint-plugin-unused-imports@^4.1.4: integrity sha512-YptD6IzQjDardkl0POxnnRBhU1OEePMV0nd6siHaRBbd+lyh6NAhFEobiznKU7kTsSsDeSD62Pe7kAM1b7dAZQ== eslint-plugin-vue@^9.12.0, eslint-plugin-vue@^9.28.0: - version "9.28.0" - resolved "https://registry.npmjs.org/eslint-plugin-vue/-/eslint-plugin-vue-9.28.0.tgz" - integrity sha512-ShrihdjIhOTxs+MfWun6oJWuk+g/LAhN+CiuOl/jjkG3l0F2AuK5NMTaWqyvBgkFtpYmyks6P4603mLmhNJW8g== + version "9.29.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-vue/-/eslint-plugin-vue-9.29.0.tgz#fa1d62a88c22102be4fb8c275929698a1aee4b04" + integrity sha512-hamyjrBhNH6Li6R1h1VF9KHfshJlKgKEg3ARbGTn72CMNDSMhWbgC7NdkRDEh25AFW+4SDATzyNM+3gWuZii8g== dependencies: "@eslint-community/eslint-utils" "^4.4.0" globals "^13.24.0" @@ -3089,7 +3089,7 @@ lodash.merge@^4.6.0, lodash.merge@^4.6.2: lodash@^4.17.19, lodash@^4.17.21: version "4.17.21" - resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== loglevel-colored-level-prefix@^1.0.0: @@ -3683,7 +3683,7 @@ npm-run-path@^6.0.0: nth-check@^2.1.1: version "2.1.1" - resolved "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz" + resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.1.1.tgz#c9eab428effce36cd6b92c924bdb000ef1f1ed1d" integrity sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w== dependencies: boolbase "^1.0.0" @@ -3873,7 +3873,7 @@ pluralize@^8.0.0: postcss-selector-parser@^6.0.15: version "6.1.2" - resolved "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz" + resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz#27ecb41fb0e3b6ba7a1ec84fff347f734c7929de" integrity sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg== dependencies: cssesc "^3.0.0" @@ -4448,7 +4448,7 @@ type-check@^0.4.0, type-check@~0.4.0: type-fest@^0.20.2: version "0.20.2" - resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4" integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ== type-fest@^0.21.3: @@ -4554,7 +4554,7 @@ uri-js@^4.2.2: util-deprecate@^1.0.2: version "1.0.2" - resolved "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== v8-compile-cache-lib@^3.0.1: @@ -4748,7 +4748,7 @@ wrappy@1: xml-name-validator@^4.0.0: version "4.0.0" - resolved "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-4.0.0.tgz" + resolved "https://registry.yarnpkg.com/xml-name-validator/-/xml-name-validator-4.0.0.tgz#79a006e2e63149a8600f15430f0a4725d1524835" integrity sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw== y18n@^5.0.5: