UNPKG

@code-pushup/eslint-plugin

Version:

Code PushUp plugin for detecting problems in source code using ESLint.📋

28 lines (27 loc) • 1.06 kB
import type { ESLintTarget } from '../config.js'; /** * Accepts a target Nx project, converts its lint configuration to Code PushUp ESLint plugin parameters. * * Use when you wish to only have a single Nx project as your Code PushUp project, without any other dependencies. * If you prefer to include all Nx projects, refer to {@link eslintConfigFromAllNxProjects} instead. * If you'd like to auto include all dependencies of the provided target project use {@link eslintConfigFromNxProjectAndDeps} instead. * * @example * import eslintPlugin, { * eslintConfigFromNxProject, * } from '@code-pushup/eslint-plugin'; * * const projectName = 'backoffice'; // <-- name from project.json * * export default { * plugins: [ * await eslintPlugin( * await eslintConfigFromNxProject(projectName) * ) * ] * } * * @param projectName Nx project name * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin} */ export declare function eslintConfigFromNxProject(projectName: string): Promise<ESLintTarget>;