knip/dist/reporters/codeowners.js

Find and fix unused dependencies, exports and files in your TypeScript and JavaScript projects

import { createOwnershipEngine } from '../util/codeowners.js';
import { relative, resolve } from '../util/path.js';
import { getColoredTitle, getIssueLine, getIssueTypeTitle } from './util/util.js';
const logIssueRecord = (issues) => {
    const sortedByFilePath = issues.sort((a, b) => (a.owner < b.owner ? -1 : 1));
    for (const { filePath, symbols, owner, parentSymbol } of sortedByFilePath) {
        console.log(getIssueLine({ owner, filePath, symbols, parentSymbol }));
    }
};
export default ({ report, issues, isShowProgress, options }) => {
    let opts = {};
    try {
        opts = options ? JSON.parse(options) : opts;
    }
    catch (error) {
        console.error(error);
    }
    const codeownersFilePath = resolve(opts.path ?? '.github/CODEOWNERS');
    const findOwners = createOwnershipEngine(codeownersFilePath);
    const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
    const [dependenciesOwner = '[no-owner]'] = findOwners('package.json');
    let totalIssues = 0;
    const calcFileOwnership = (filePath) => findOwners(relative(filePath))[0] ?? dependenciesOwner;
    const addOwner = (issue) => ({
        ...issue,
        owner: calcFileOwnership(issue.filePath),
    });
    for (let [reportType, isReportType] of Object.entries(report)) {
        if (reportType === 'files')
            reportType = '_files';
        if (isReportType) {
            const title = reportMultipleGroups && getIssueTypeTitle(reportType);
            const issuesForType = Object.values(issues[reportType]).flatMap(issues => {
                if (reportType === 'duplicates')
                    return Object.values(issues).map(addOwner);
                const symbols = Object.values(issues);
                return addOwner({ ...symbols[0], symbols });
            });
            if (issuesForType.length > 0) {
                if (totalIssues)
                    console.log();
                title && console.log(getColoredTitle(title, issuesForType.length));
                logIssueRecord(issuesForType);
            }
            totalIssues = totalIssues + issuesForType.length;
        }
    }
    if (totalIssues === 0 && isShowProgress) {
        console.log('✂️  Excellent, Knip found no issues.');
    }
};