declapract/dist/logic/usage/evaluate/evaluateProjectAgainstPracticeDeclarations.d.ts

A tool to declaratively define best practices, maintainable evolve them, and scalably enforce them.

import { PracticeDeclaration } from '../../../domain';
import { FilePracticeEvaluation } from '../../../domain/objects/FilePracticeEvaluation';
import { ProjectCheckContext } from '../../../domain/objects/ProjectCheckContext';
/**
 * given:
 * - practice declarations
 * - directory to project
 *
 * does:
 * - check that the project conforms to the practices specified
 *
 * note: not checking against use case specifically because we may be asked to apply multiple use cases to the same project
 */
export declare const evaluateProjectAgainstPracticeDeclarations: ({ practices, project, }: {
    practices: PracticeDeclaration[];
    project: ProjectCheckContext;
}) => Promise<FilePracticeEvaluation[]>;