-
Notifications
You must be signed in to change notification settings - Fork 391
141 lines (125 loc) · 5.36 KB
/
knip.yml
File metadata and controls
141 lines (125 loc) · 5.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
name: Knip - Unused Code Analysis
on:
pull_request:
branches: [main]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
knip:
timeout-minutes: 10
runs-on: ubuntu-24.04
permissions:
contents: read
pull-requests: write
steps:
- name: Checkout PR branch
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- name: Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache-dependency-path: 'yarn.lock'
cache: 'yarn'
- 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: Compare results and comment
uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0
with:
script: |
const fs = require('fs');
function countIssues(filePath) {
try {
const raw = fs.readFileSync(filePath, 'utf8');
const data = JSON.parse(raw);
const counts = {};
const issueCategories = [
'files', 'dependencies', 'devDependencies', 'unlisted',
'unresolved', 'binaries', 'exports', 'types',
'enumMembers', 'duplicates'
];
for (const issue of data.issues || []) {
for (const cat of issueCategories) {
if (Array.isArray(issue[cat]) && issue[cat].length > 0) {
counts[cat] = (counts[cat] || 0) + issue[cat].length;
}
}
}
let total = 0;
for (const v of Object.values(counts)) total += v;
return { counts, total };
} catch (e) {
console.log(`Failed to parse ${filePath}: ${e.message}`);
return { counts: {}, total: 0 };
}
}
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`;
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`;
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`;
}
body += `\n<details><summary>What is this?</summary>\n\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({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}