@code-pushup/eslint-plugin 0.1.0

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@code-pushup/eslint-plugin",
+  "version": "0.1.0",
+  "dependencies": {
+    "@code-pushup/utils": "*",
+    "eslint": "~8.46.0",
+    "zod": "^3.22.4",
+    "@code-pushup/models": "*"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "types": "./src/index.d.ts"
+}

package/src/bin.d.ts

@@ -0,0 +1 @@
+export {};

package/src/index.d.ts

@@ -0,0 +1,3 @@
+import { eslintPlugin } from './lib/eslint-plugin';
+export default eslintPlugin;
+export type { ESLintPluginConfig } from './lib/config';

package/src/lib/config.d.ts

@@ -0,0 +1,13 @@
+import type { ESLint } from 'eslint';
+import { type ZodType, z } from 'zod';
+export declare const eslintPluginConfigSchema: z.ZodObject<{
+    eslintrc: z.ZodUnion<[z.ZodString, ZodType<ESLint.ConfigData<import("eslint").Linter.RulesRecord>, z.ZodTypeDef, ESLint.ConfigData<import("eslint").Linter.RulesRecord>>]>;
+    patterns: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}>;
+export type ESLintPluginConfig = z.infer<typeof eslintPluginConfigSchema>;

package/src/lib/eslint-plugin.d.ts

@@ -0,0 +1,23 @@
+import { PluginConfig } from '@code-pushup/models';
+import { ESLintPluginConfig } from './config';
+/**
+ * Instantiates Code PushUp ESLint plugin for use in core config.
+ *
+ * @example
+ * import eslintPlugin from '@code-pushup/eslint-plugin'
+ *
+ * export default {
+ *   // ... core config ...
+ *   plugins: [
+ *     // ... other plugins ...
+ *     await eslintPlugin({
+ *       eslintrc: '.eslintrc.json',
+ *       patterns: ['src', 'test/*.spec.js']
+ *     })
+ *   ]
+ * }
+ *
+ * @param config Configuration options.
+ * @returns Plugin configuration as a promise.
+ */
+export declare function eslintPlugin(config: ESLintPluginConfig): Promise<PluginConfig>;

package/src/lib/meta/groups.d.ts

@@ -0,0 +1,4 @@
+import type { AuditGroup } from '@code-pushup/models';
+import { type RuleData } from './rules';
+export declare function groupsFromRuleTypes(rules: RuleData[]): AuditGroup[];
+export declare function groupsFromRuleCategories(rules: RuleData[]): AuditGroup[];

package/src/lib/meta/hash.d.ts

@@ -0,0 +1,2 @@
+export declare function ruleIdToSlug(ruleId: string, options: unknown[] | undefined): string;
+export declare function jsonHash(data: unknown, bytes?: number): string;

package/src/lib/meta/index.d.ts

@@ -0,0 +1,6 @@
+import type { ESLint } from 'eslint';
+import type { Audit, AuditGroup } from '@code-pushup/models';
+export declare function listAuditsAndGroups(eslint: ESLint, patterns: string | string[]): Promise<{
+    audits: Audit[];
+    groups: AuditGroup[];
+}>;

package/src/lib/meta/rules.d.ts

@@ -0,0 +1,11 @@
+import type { ESLint, Rule } from 'eslint';
+export type RuleData = {
+    ruleId: string;
+    meta: Rule.RuleMetaData;
+    options: unknown[] | undefined;
+};
+export declare function listRules(eslint: ESLint, patterns: string | string[]): Promise<RuleData[]>;
+export declare function parseRuleId(ruleId: string): {
+    plugin?: string;
+    name: string;
+};

package/src/lib/meta/transform.d.ts

@@ -0,0 +1,3 @@
+import type { Audit } from '@code-pushup/models';
+import { RuleData } from './rules';
+export declare function ruleToAudit({ ruleId, meta, options }: RuleData): Audit;

package/src/lib/runner/index.d.ts

@@ -0,0 +1,6 @@
+import type { Audit, RunnerConfig } from '@code-pushup/models';
+export declare const WORKDIR: string;
+export declare const RUNNER_OUTPUT_PATH: string;
+export declare const ESLINTRC_PATH: string;
+export declare function executeRunner(argv?: string[]): Promise<void>;
+export declare function createRunnerConfig(scriptPath: string, audits: Audit[], eslintrc: string, patterns: string | string[]): RunnerConfig;

package/src/lib/runner/lint.d.ts

@@ -0,0 +1,3 @@
+import { ESLintPluginConfig } from '../config';
+import type { LinterOutput } from './types';
+export declare function lint({ eslintrc, patterns, }: ESLintPluginConfig): Promise<LinterOutput>;

package/src/lib/runner/transform.d.ts

@@ -0,0 +1,3 @@
+import type { AuditOutput } from '@code-pushup/models';
+import type { LinterOutput } from './types';
+export declare function lintResultsToAudits({ results, ruleOptionsPerFile, }: LinterOutput): AuditOutput[];

package/src/lib/runner/types.d.ts

@@ -0,0 +1,13 @@
+import type { ESLint } from 'eslint';
+export type LinterOutput = {
+    results: LintResult[];
+    ruleOptionsPerFile: RuleOptionsPerFile;
+};
+export type LintResult = ESLint.LintResult & {
+    relativeFilePath: string;
+};
+export type RuleOptionsPerFile = {
+    [filePath: string]: {
+        [ruleId: string]: unknown[];
+    };
+};

package/src/lib/setup.d.ts

@@ -0,0 +1,3 @@
+import { ESLint } from 'eslint';
+import { ESLintPluginConfig } from './config';
+export declare function setupESLint(eslintrc: ESLintPluginConfig['eslintrc']): ESLint;