Knip: Dein Detektiv für ungenutzten Code in JavaScript & TypeScript

Knip ist ein unverzichtbares Kommandozeilen-Tool (CLI) für moderne JavaScript- und TypeScript-Entwickler. Seine Hauptaufgabe ist es, ungenutzte Dateien, Abhängigkeiten (Dependencies) und Exporte in deinen Projekten aufzuspüren. Stell dir Knip als einen fleißigen Helfer vor, der deine Codebasis aufräumt, indem er "toten Code" und überflüssige Elemente identifiziert, die dein Projekt unnötig aufblähen und die Wartung erschweren können.

Knip durchleuchtet dein Projekt und analysiert, welche Teile deines Codes tatsächlich verwendet werden. Im Detail bedeutet das, dass Knip ungenutzte Dateien wie .js, .ts, .jsx, .tsx und andere konfigurierbare Dateitypen identifiziert, die in deinem Projekt existieren, aber nirgendwo importiert oder referenziert werden. Des Weiteren prüft es deine package.json auf ungenutzte Abhängigkeiten, also dependencies und devDependencies, die zwar installiert, aber in deinem Code nicht importiert oder verwendet werden. Eine besondere Stärke von Knip liegt in der Fähigkeit, ungenutzte Exporte zu finden – dazu zählen exportierte Funktionen, Klassen, Variablen, Typen, Interfaces und Enums, die in keinem anderen Teil deines Projekts importiert und genutzt werden, unabhängig davon, ob es sich um benannte oder Standard-Exporte handelt. In einigen Fällen, oft konfigurierbar oder als experimentelles Feature, kann Knip sogar ungenutzte Member innerhalb von Enums oder Klassen aufspüren.

Der Einsatz von Knip bringt eine Reihe signifikanter Vorteile für dein Projekt und deinen Entwicklungsworkflow. Zunächst führt er zu einer verbesserten Code-Qualität und -Hygiene, da überflüssiger Ballast entfernt und die Codebasis schlanker sowie sauberer wird. Dies kann sich direkt in reduzierten Bundle-Größen und kürzeren Ladezeiten deiner Anwendung niederschlagen, da weniger Code oft kleinere Produktions-Bundles bedeutet. Eine aufgeräumte Codebasis resultiert zudem in einer gesteigerten Wartbarkeit; sie ist leichter zu verstehen, zu pflegen und weiterzuentwickeln, und das Risiko, auf veralteten Code zu stoßen, sinkt. Auch Refactorings und Umbauten fallen leichter und sicherer aus, wenn klar ist, welcher Code tatsächlich genutzt wird. Indirekt können auch schnellere Build-Zeiten eine Folge sein, da das Entfernen unnötiger Dateien und Abhängigkeiten die Komplexität für Build-Tools reduzieren kann. Knip hilft dabei, die Entstehung von sogenanntem "Zombie-Code" zu vermeiden – also Code, der einmal nützlich war, aber nicht mehr benötigt wird und Verwirrung stiftet. Schließlich ermöglicht es eine bessere Übersicht über deine Abhängigkeiten, was das Lizenzmanagement vereinfacht und hilft, den Überblick über tatsächlich genutzte Pakete zu behalten.

Knip arbeitet primär mittels statischer Code-Analyse. Es parst deine JavaScript/TypeScript-Dateien, um Import- und Export-Beziehungen zu verstehen. Es baut einen Graphen deiner Projektstruktur auf: Es startet bei definierten Einstiegspunkten (z.B. index.js, main.ts, Konfigurationsdateien von Frameworks). Von dort aus verfolgt es alle import-Anweisungen, um zu sehen, welche Dateien und Exporte tatsächlich erreicht und genutzt werden. Es gleicht die gefundenen Importe von externen Modulen mit den in package.json deklarierten Abhängigkeiten ab. Am Ende listet es alle Elemente auf, die nicht Teil dieses "genutzten Graphen" sind.

Knip zeichnet sich durch mehrere Kernfunktionen und Merkmale aus. Es bietet eine umfassende Analyse, die über einfache Abhängigkeitsprüfungen hinausgeht und auch die Nutzung von Dateien und einzelnen Exporten berücksichtigt. Dabei ist es für JavaScript und TypeScript optimiert und versteht deren Modulsysteme (ESM, CommonJS). Für komplexe Projekte ist die Monorepo-Unterstützung besonders wertvoll, da Knip effektiv in Strukturen mit mehreren Paketen eingesetzt werden kann. Obwohl es oft "out-of-the-box" gut funktioniert und für viele gängige Setups eine "Zero Config"-Erfahrung bietet, ist es hochgradig konfigurierbar. Über eine knip.json oder knip.ts Datei lässt es sich detailliert an projektspezifische Bedürfnisse anpassen, beispielsweise durch das Ignorieren bestimmter Pfade oder die Definition von Entry Points. Knip stellt oft Plugins und Integrationen bereit oder ist kompatibel mit populären Tools und Frameworks wie Next.js, SvelteKit oder Astro. Trotz seiner Gründlichkeit ist es auf Performance ausgelegt, um auch große Codebasen effizient analysieren zu können. Schließlich ist Knip automatisierungsfreundlich und eignet sich ideal für die Integration in CI/CD-Pipelines, um Code-Hygiene kontinuierlich sicherzustellen.

Knip wird typischerweise als Development-Abhängigkeit zu deinem Projekt hinzugefügt. Dies geschieht mit einem der folgenden Befehle, je nachdem welchen Paketmanager du verwendest:

Für npm:

Für yarn:

Für pnpm:

pnpm add -D knip

Anschließend kannst du Knip über npx ausführen oder ein Skript in deiner package.json definieren. Ein einfacher Aufruf sieht so aus:

Ein häufig genutzter Modus ist der --production Modus, der sich auf Code konzentriert, der für die Produktion relevant ist. (Knip gibt dann eine Liste der gefundenen ungenutzten Elemente aus):

Für komplexere Projekte oder um False Positives zu behandeln, kannst du eine knip.json (oder knip.js/knip.ts) im Wurzelverzeichnis deines Projekts erstellen. Typische Konfigurationsoptionen umfassen hierbei entry, um die Einstiegspunkte deiner Anwendung zu definieren (z.B. src/index.ts, pages/**/*.tsx), und project, um die zu analysierenden Code-Pfade festzulegen. Mit ignore können Pfade oder Muster von der Analyse ausgeschlossen werden. Speziell für Abhängigkeiten gibt es ignoreDependencies und für Exporte ignoreExports, um diese als genutzt zu markieren, was besonders bei dynamischer Nutzung hilfreich ist.

Ein Beispiel für eine einfache knip.json könnte so aussehen:

(Das ! am Ende von Pfaden ist eine Konvention in Knip, um anzuzeigen, dass es sich um einen "production" oder "project" Datei-Glob handelt.)

{
 "entry": ["src/main.ts!", "src/scripts/**/*.ts!"],
 "project": ["src/**/*.ts!"],
 "ignore": ["src/generated/**"],
 "ignoreExports": ["src/someDynamicallyUsedModule.ts#someFunction"]
}

Knip findet in verschiedenen Szenarien praktische Anwendung. Entwickler nutzen es für regelmäßige Code-Audits, um die Codebasis periodisch zu säubern und sauber zu halten. Es ist besonders nützlich vor einem Major Release, um sicherzustellen, dass kein unnötiger Code mit ausgeliefert wird. Bei der Übernahme eines bestehenden Projekts hilft Knip, schnell einen Überblick über potenziell veralteten Code zu bekommen. Ein sehr verbreiteter Einsatz ist als Teil des CI/CD-Prozesses, wo Knip in die Pipeline integriert wird, um automatisch zu prüfen und gegebenenfalls den Build fehlschlagen zu lassen, wenn ungenutzter Code gefunden wird. Schließlich ist es ein wertvolles Werkzeug nach größeren Refactorings, um zu überprüfen, ob alle alten, nicht mehr benötigten Teile tatsächlich entfernt wurden.

Es gibt andere Tools wie depcheck, die sich primär auf ungenutzte Abhängigkeiten in package.json konzentrieren. Knip geht hier deutlich weiter, indem es auch die tatsächliche Nutzung von Dateien und einzelnen Exporten innerhalb des Codes analysiert, was es zu einem umfassenderen Werkzeug für die Code-Hygiene macht.

Knip ist ein mächtiges und wertvolles Werkzeug im Arsenal jedes JavaScript- und TypeScript-Entwicklers. Durch die Fähigkeit, ungenutzte Dateien, Abhängigkeiten und Exporte zuverlässig aufzuspüren, hilft es, Codebasen sauber, wartbar und performant zu halten. Die Investition in die Einrichtung und regelmäßige Nutzung von Knip zahlt sich schnell durch eine verbesserte Entwicklererfahrung und robustere Anwendungen aus.

Die offizielle Webseite findest du unter https://knip.dev/.
Das GitHub Repository ist erreichbar unter https://github.com/webpro-nl/knip.