feat(plugin-eslint): add docs url

code-pushup · Dec 4, 2023 · d6a6b2a · d6a6b2a
1 parent 3e39810
commit d6a6b2a
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/e2e/cli-e2e/tests/__snapshots__/collect.e2e.test.ts.snap b/e2e/cli-e2e/tests/__snapshots__/collect.e2e.test.ts.snap
@@ -993,6 +993,7 @@ exports[`CLI collect > should run ESLint plugin and create report.json 1`] = `
         },
       ],
       "description": "Official Code PushUp ESLint plugin",
+      "docsUrl": "https://www.npmjs.com/package/@code-pushup/eslint-plugin",
       "groups": [
         {
           "description": "Code that either will cause an error or may cause confusing behavior. Developers should consider this a high priority to resolve.",

diff --git a/packages/plugin-eslint/src/lib/__snapshots__/eslint-plugin.integration.test.ts.snap b/packages/plugin-eslint/src/lib/__snapshots__/eslint-plugin.integration.test.ts.snap
@@ -287,6 +287,7 @@ exports[`eslintPlugin > should initialize ESLint plugin for React application 1`
     },
   ],
   "description": "Official Code PushUp ESLint plugin",
+  "docsUrl": "https://www.npmjs.com/package/@code-pushup/eslint-plugin",
   "groups": [
     {
       "description": "Code that either will cause an error or may cause confusing behavior. Developers should consider this a high priority to resolve.",

diff --git a/packages/plugin-eslint/src/lib/eslint-plugin.ts b/packages/plugin-eslint/src/lib/eslint-plugin.ts
@@ -54,7 +54,7 @@ export async function eslintPlugin(
     title: 'ESLint',
     icon: 'eslint',
     description: 'Official Code PushUp ESLint plugin',
-    // TODO: docsUrl (package README, once published)
+    docsUrl: 'https://www.npmjs.com/package/@code-pushup/eslint-plugin',
     packageName: name,
     version,