Skip to content

chore: refactor knip CI to fail on issues and simplify comment format #2003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 8 commits into from
Apr 1, 2026
+99 −102
Merged

chore: refactor knip CI to fail on issues and simplify comment format #2003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5ae1afd
chore: refactor knip CI to fail on issues and simplify comment format
brandon-pereira Mar 27, 2026
f25e0af
fix: parse unused files from issues array in knip JSON output
brandon-pereira Mar 27, 2026
01458db
chore: remove knip test fixtures
brandon-pereira Mar 27, 2026
1174c8d
Merge branch 'main' into brandon/knip-error
brandon-pereira Mar 30, 2026
aeb51f6
Merge branch 'main' into brandon/knip-error
brandon-pereira Mar 30, 2026
8e7e0d5
Merge branch 'main' into brandon/knip-error
brandon-pereira Apr 1, 2026
a302214
tweak knip workflow to support push and fork PRs
brandon-pereira Apr 1, 2026
cc44e1b
fix existing knip issues
brandon-pereira Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 97 additions & 102 deletions .github/workflows/knip.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
name: Knip - Unused Code Analysis
on:
push:
branches: [main]
pull_request:
branches: [main]
concurrency:
Expand All @@ -26,153 +28,146 @@ jobs:
- name: Install dependencies
run: yarn install

- name: Run Knip on PR branch
run: yarn knip --reporter json > /tmp/knip-pr.json 2>/dev/null || true

- name: Checkout main branch
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
with:
ref: main
clean: false

- name: Install dependencies (main)
run: yarn install

- name: Run Knip on main branch
run: yarn knip --reporter json > /tmp/knip-main.json 2>/dev/null || true
- name: Run Knip
run:
yarn knip --reporter json > /tmp/knip-results.json 2>/dev/null || true

- name: Compare results and comment
- name: Report results
uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0
env:
IS_FORK_PR:
${{ github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.fork == true }}
IS_PR: ${{ github.event_name == 'pull_request' }}
with:
script: |
const fs = require('fs');
const isForkPR = process.env.IS_FORK_PR === 'true';
const isPR = process.env.IS_PR === 'true';

const issueCategories = [
'files', 'dependencies', 'devDependencies', 'unlisted',
'unresolved', 'binaries', 'exports', 'types',
'enumMembers', 'duplicates'
];

function countIssues(filePath) {
const categoryLabels = {
files: 'Unused files',
dependencies: 'Unused dependencies',
devDependencies: 'Unused devDependencies',
unlisted: 'Unlisted dependencies',
unresolved: 'Unresolved imports',
binaries: 'Unlisted binaries',
exports: 'Unused exports',
types: 'Unused exported types',
};

function parseResults(filePath) {
try {
const raw = fs.readFileSync(filePath, 'utf8');
const data = JSON.parse(raw);
const counts = {};
// items maps category -> Set of "file:name" identifiers
const items = {};
for (const cat of issueCategories) items[cat] = new Set();
// Top-level "files" are unused files (just strings)
for (const f of data.files || []) {
counts.files = (counts.files || 0) + 1;
items.files.add(f);
}
for (const cat of issueCategories) items[cat] = [];

for (const issue of data.issues || []) {
for (const cat of issueCategories) {
if (cat === 'files') continue;
if (Array.isArray(issue[cat]) && issue[cat].length > 0) {
counts[cat] = (counts[cat] || 0) + issue[cat].length;
for (const item of issue[cat]) {
items[cat].add(`${issue.file}:${item.name}`);
// Unused files use the file path as the name; other categories prefix with the parent file
const label = cat === 'files' ? item.name : `${issue.file}:${item.name}`;
items[cat].push(label);
}
}
}
}

let total = 0;
for (const v of Object.values(counts)) total += v;
return { counts, total, items };
} catch (e) {
console.log(`Failed to parse ${filePath}: ${e.message}`);
const items = {};
for (const cat of issueCategories) items[cat] = new Set();
for (const cat of issueCategories) items[cat] = [];
return { counts: {}, total: 0, items };
}
}

const pr = countIssues('/tmp/knip-pr.json');
const main = countIssues('/tmp/knip-main.json');

const categories = [
['files', 'Unused files'],
['dependencies', 'Unused dependencies'],
['devDependencies', 'Unused devDependencies'],
['unlisted', 'Unlisted dependencies'],
['unresolved', 'Unresolved imports'],
['binaries', 'Unlisted binaries'],
['exports', 'Unused exports'],
['types', 'Unused exported types'],
['enumMembers', 'Unused enum members'],
['duplicates', 'Duplicate exports'],
];

const diff = pr.total - main.total;
const emoji = diff > 0 ? '🔴' : diff < 0 ? '🟢' : '⚪';
const sign = diff > 0 ? '+' : '';

let body = `## Knip - Unused Code Analysis\n\n`;

if (diff === 0) {
body += `${emoji} No changes detected (${main.total} issues on both main and PR)\n`;
} else {
body += `${emoji} **${sign}${diff}** change in total issues (${main.total} on main → ${pr.total} on PR)\n\n`;
body += `| Category | main | PR | Diff |\n`;
body += `|----------|-----:|---:|-----:|\n`;

const detailLines = [];
for (const [key, label] of categories) {
const mainCount = main.counts[key] || 0;
const prCount = pr.counts[key] || 0;
const catDiff = prCount - mainCount;
if (mainCount === 0 && prCount === 0) continue;
const catSign = catDiff > 0 ? '+' : '';
const catEmoji = catDiff > 0 ? ' 🔴' : catDiff < 0 ? ' 🟢' : '';
body += `| ${label} | ${mainCount} | ${prCount} | ${catSign}${catDiff}${catEmoji} |\n`;

if (catDiff !== 0) {
const added = [...pr.items[key]].filter(x => !main.items[key].has(x));
const removed = [...main.items[key]].filter(x => !pr.items[key].has(x));
if (added.length || removed.length) {
detailLines.push(`**${label}**`);
for (const a of added) detailLines.push(`- 🔴 \`${a}\``);
for (const r of removed) detailLines.push(`- 🟢 ~\`${r}\`~`);
}
const results = parseResults('/tmp/knip-results.json');

if (results.total === 0) {
console.log('No knip issues found.');

// Clean up existing PR comment if present
if (isPR && !isForkPR) {
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
const existing = comments.find(c =>
c.user.type === 'Bot' && c.body.includes('Knip - Unused Code Analysis')
);
if (existing) {
await github.rest.issues.deleteComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
});
}
}
return;
}

if (detailLines.length) {
body += `\n<details><summary>Details</summary>\n\n`;
body += detailLines.join('\n') + '\n';
body += `</details>\n`;
// Build report body
let body = `## Knip - Unused Code Analysis\n\n`;
body += `🔴 **${results.total} issue${results.total === 1 ? '' : 's'}** found\n\n`;

for (const cat of issueCategories) {
const count = results.counts[cat] || 0;
if (count === 0) continue;
const label = categoryLabels[cat];
body += `### ${label} (${count})\n\n`;
for (const item of results.items[cat]) {
body += `- \`${item}\`\n`;
}
body += `\n`;
}

body += `\n<details><summary>What is this?</summary>\n\n`;
body += `---\n`;
body += `[Knip](https://knip.dev) finds unused files, dependencies, and exports in your codebase.\n`;
body += `This comment compares the PR branch against \`main\` to detect regressions.\n\n`;
body += `Run \`yarn knip\` locally to see full details.\n`;
body += `</details>\n`;

// Find existing comment
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
const existing = comments.find(c =>
c.user.type === 'Bot' && c.body.includes('Knip - Unused Code Analysis')
);

if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({

// Always log to console (visible in Actions output for pushes and forks)
console.log(body);

// Comment on PR only for non-fork PRs (GITHUB_TOKEN can't write to base repo from forks)
if (isPR && !isForkPR) {
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
const existing = comments.find(c =>
c.user.type === 'Bot' && c.body.includes('Knip - Unused Code Analysis')
);

if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}
}

// Fail the job since there are issues
core.setFailed(`Knip found ${results.total} issue${results.total === 1 ? '' : 's'}. Run \`yarn knip\` locally to fix them.`);
2 changes: 2 additions & 0 deletions knip.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@
"project": ["src/**/*.ts"]
}
},
"ignore": ["scripts/dev-portal/**"],
Copy link
Copy Markdown
Member Author

@brandon-pereira brandon-pereira Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

existing knip issues

"ignoreBinaries": ["make", "migrate", "playwright"],
"ignoreDependencies": [
"@dotenvx/dotenvx",
"concurrently",
"dotenv",
"babel-plugin-react-compiler"
Expand Down
Loading