feat(plugin-eslint): include NPM package name and version

Author: matejchalk

packages/plugin-eslint/src/lib/__snapshots__/eslint-plugin.spec.ts.snap

@@ -437,6 +437,7 @@ Custom options:
   ],
   "description": "Official Code PushUp ESLint plugin",
   "icon": "eslint",
+  "packageName": "@code-pushup/eslint-plugin",
   "runner": {
     "args": [
       "eslint",
@@ -451,6 +452,7 @@ Custom options:
   },
   "slug": "eslint",
   "title": "ESLint",
+  "version": "0.0.1",
 }
 `;
 
@@ -742,6 +744,7 @@ exports[`eslintPlugin > should initialize ESLint plugin for React application 1`
   ],
   "description": "Official Code PushUp ESLint plugin",
   "icon": "eslint",
+  "packageName": "@code-pushup/eslint-plugin",
   "runner": {
     "args": [
       "eslint",
@@ -756,5 +759,6 @@ exports[`eslintPlugin > should initialize ESLint plugin for React application 1`
   },
   "slug": "eslint",
   "title": "ESLint",
+  "version": "0.0.1",
 }
 `;

packages/plugin-eslint/src/lib/eslint-plugin.spec.ts

@@ -24,19 +24,21 @@ describe('eslintPlugin', () => {
 
   it('should initialize ESLint plugin for React application', async () => {
     cwdSpy.mockReturnValue(join(fixturesDir, 'todos-app'));
-    const plugin = await eslintPlugin({
-      eslintrc: '.eslintrc.js',
-      patterns: ['src/**/*.js', 'src/**/*.jsx'],
-    });
-    expect(plugin).toMatchSnapshot();
+    await expect(
+      eslintPlugin({
+        eslintrc: '.eslintrc.js',
+        patterns: ['src/**/*.js', 'src/**/*.jsx'],
+      }),
+    ).resolves.toMatchSnapshot();
   });
 
   it('should initialize ESLint plugin for Nx project', async () => {
     cwdSpy.mockReturnValue(join(fixturesDir, 'nx-monorepo'));
-    const plugin = await eslintPlugin({
-      eslintrc: './packages/utils/.eslintrc.json',
-      patterns: ['packages/utils/**/*.ts', 'packages/utils/**/*.json'],
-    });
-    expect(plugin).toMatchSnapshot();
+    await expect(
+      eslintPlugin({
+        eslintrc: './packages/utils/.eslintrc.json',
+        patterns: ['packages/utils/**/*.ts', 'packages/utils/**/*.json'],
+      }),
+    ).resolves.toMatchSnapshot();
   });
 });

packages/plugin-eslint/src/lib/eslint-plugin.ts

@@ -1,6 +1,7 @@
 import { PluginConfig } from '@quality-metrics/models';
 import { toArray } from '@quality-metrics/utils';
 import { ESLint } from 'eslint';
+import { name, version } from '../../package.json';
 import { listAudits } from './meta/audits';
 
 export type ESLintPluginConfig = {
@@ -24,8 +25,17 @@ export async function eslintPlugin({
     title: 'ESLint',
     icon: 'eslint',
     description: 'Official Code PushUp ESLint plugin',
-    // TODO: docsUrl (package README)
+    // TODO: docsUrl (package README, once published)
+    packageName: name,
+    version,
+
     audits,
+
+    // TODO: groups?
+    // - could be `problem`/`suggestion`/`layout` if based on `meta.type`
+    // - `meta.category` (deprecated, but still used by some) could also be a source of groups
+
+    // TODO: implement actual runner which converts results to audits: https://github.com/flowup/quality-metrics-cli/issues/27
     runner: {
       command: 'npx',
       args: [