8 Node Packet Manager (npm / yarn)

Der Node Package Manager (npm) und Yarn sind zwei beliebte Paketmanager für JavaScript. Sie werden verwendet, um Module und Pakete zu verwalten, die in einem JavaScript-Projekt benötigt werden, einschließlich derer, die TypeScript-spezifisch sind. Sie ermöglichen es Entwicklern, Pakete aus der umfangreichen npm-Registry zu installieren, die Tausende von Open-Source-JavaScript-Paketen enthält.

8.1 Die package.json-Datei

Die package.json-Datei ist eine wichtige Datei in Node.js-Projekten, einschließlich TypeScript-Projekten. Sie enthält Metadaten über das Projekt und seine Abhängigkeiten und konfiguriert verschiedene Aspekte des Projekts. Sie wird automatisch erstellt, wenn Sie npm init in Ihrem Projektverzeichnis ausführen.

Hier sind die wichtigsten Felder in der package.json-Datei:

name: Der Name Ihres Projekts. Dies ist ein erforderlicher Wert und muss eindeutig sein, wenn Sie planen, Ihr Paket auf npm zu veröffentlichen.
version: Die aktuelle Version Ihres Projekts.
description: Eine kurze Beschreibung Ihres Projekts.
main: Die Einstiegspunkt-Datei Ihres Projekts. Dies ist die Datei, die ausgeführt wird, wenn andere Ihr Paket als Abhängigkeit verwenden und es als Modul importieren.
scripts: Ein Objekt, das Befehle definiert, die Sie ausführen können, indem Sie npm run verwenden. Sie können diese Skripte verwenden, um Aufgaben wie das Starten des Projekts, das Ausführen von Tests und das Bauen des Projekts zu automatisieren.
dependencies: Ein Objekt, das die Abhängigkeiten Ihres Projekts auflistet. Dies sind die Pakete, die Ihr Projekt zur Laufzeit benötigt.
devDependencies: Ein Objekt, das die Entwicklungsabhängigkeiten Ihres Projekts auflistet. Dies sind Pakete, die Ihr Projekt nur zur Entwicklungszeit benötigt, wie Test-Frameworks und Build-Tools.

Die package.json-Datei kann auch viele andere Felder enthalten, abhängig von den spezifischen Bedürfnissen Ihres Projekts. Sie können mehr über die package.json-Datei in der offiziellen npm-Dokumentation erfahren.

Ein Beispiel für eine package json könnte so aussehen:

{
    "name": "my_project",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "build": "./node_modules/.bin/tsc",
        "prestart": "npm run build",
        "start": "node ./dist/index.js",
        "test": "echo \"Error: no test specified\" && exit 1"
    },
    "author": "",
    "license": "ISC",
    "devDependencies": {
        "@types/node": "^20.4.2",
        "tslint": "^6.1.3",
        "typescript": "^5.1.6"
    }
}

8.2 Node Package Manager (npm)

npm ist der Standardpaketmanager für Node.js und kommt mit Node.js bei der Installation. Es ermöglicht es Ihnen, Pakete zu installieren und zu verwalten, Skripte auszuführen und Abhängigkeiten für Ihr Projekt zu verwalten. npm verwaltet auch semantische Versionierung, sodass Sie spezifizieren können, welche Versionen Ihrer Abhängigkeiten Sie in Ihrem Projekt verwenden möchten.

Hier sind einige grundlegende Befehle, die Sie mit npm ausführen können:

Installieren Sie ein Paket: npm install <package>
Installieren Sie ein Paket und speichern Sie es als Abhängigkeit in Ihrer package.json Datei: npm install --save <package>
Installieren Sie alle Abhängigkeiten für Ihr Projekt, die in Ihrer package.json Datei aufgeführt sind: npm install
Führen Sie ein Skript aus Ihrer package.json Datei aus: npm run <script>

8.3 Yarn

Yarn ist ein weiterer Paketmanager, der als Alternative zu npm entwickelt wurde. Es wurde von Facebook entwickelt und bietet ähnliche Funktionen wie npm, konzentriert sich aber stärker auf Geschwindigkeit und Konsistenz. Es verwendet eine yarn.lock Datei, um die exakte Version jeder Abhängigkeit Ihres Projekts aufzuzeichnen, was dazu beiträgt, dass die Installation von Abhängigkeiten auf verschiedenen Maschinen konsistent ist.

Hier sind einige grundlegende Befehle, die Sie mit Yarn ausführen können:

Installieren Sie ein Paket: yarn add <package>
Installieren Sie alle Abhängigkeiten für Ihr Projekt, die in Ihrer package.json Datei aufgeführt sind: yarn install
Führen Sie ein Skript aus Ihrer package.json Datei aus: yarn run <script>

Sowohl npm als auch Yarn sind wichtige Werkzeuge für die Arbeit mit JavaScript und TypeScript. Die Auswahl zwischen den beiden hängt oft von den Vorlieben des Entwicklerteams oder von spezifischen Projektanforderungen ab.

8.4 Run npm start in vscode

Mit VSCode können Sie npm start in Ihre launch.json Datei eintragen, um den Debugger zu starten. Dies ist besonders nützlich, wenn Sie während des Ausführens Ihrer Anwendung debuggen möchten.

Hier ist ein Beispiel, wie Sie npm start in launch.json eintragen können:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch via NPM",
            "runtimeExecutable": "npm",
            "runtimeArgs": [
                "run-script",
                "start"
            ],
            "console": "integratedTerminal"
        }
    ]
}

In diesem Beispiel wird npm start verwendet, um Ihre Anwendung zu starten, und der Debugger wird an den Port 9229 gebunden. Sie können den Port anpassen, wenn Ihre Anwendung einen anderen Debug-Port verwendet.

Bitte beachten Sie, dass Sie den Debugger starten können, indem Sie auf das Käfer-Symbol in der linken Seitenleiste klicken und dann auf den grünen Pfeil neben “Launch via NPM” klicken.