mitmario.dev

ESM

Node.js Sandbox 5 Min Lesezeit 3 BeispieleLektion 2 von 7

require gibt es nur in Node. Der Browser kennt es nicht. Code, der an beiden Orten laufen soll, braucht also ein Modulsystem, das zur Sprache selbst gehört. Das heißt ESM, kurz für ECMAScript Modules, und es funktioniert im Browser genauso. Ab dieser Lektion steht im Kurs nur noch ESM.

Herausgeben und hereinholen

Statt module.exports steht hier das Schlüsselwort export direkt vor dem, was herausgehen soll. Statt require gibt es import.

Dasselbe Beispiel als Modul
import halbieren, { verdoppeln, gruss } from "./mathe.mjs";

console.log(gruss);
console.log(verdoppeln(21));
console.log(halbieren(10));

Das ist das erste Beispiel der vorigen Lektion, nur als Modul geschrieben und um eine Funktion reicher. Im Beispiel stehen zwei Sorten Export.

Benannte Exporte stehen vor einer Deklaration und behalten ihren Namen. Wer sie hereinholt, schreibt sie in geschweifte Klammern und muss den Namen genau treffen.

Der Standard-Export heißt export default und ist pro Datei nur einmal erlaubt. Er hat keinen Namen, und die andere Seite darf ihn deshalb nennen, wie sie will. Im Beispiel steht er ohne Klammern ganz vorn im Import.

Gibt eine Datei genau ein Ding heraus, ist default in Ordnung. Bei mehreren sind benannte Exporte besser. Die findet man leichter, und der Editor kann sie automatisch ergänzen.

Drei Wege, eine Datei zu ESM zu machen

Vor dem Ausführen muss Node wissen, welches der beiden Systeme gilt. Dafür gibt es drei Antworten:

  1. In der package.json des Projekts steht "type": "module". Dann sind alle .js-Dateien Module. Das ist der Normalfall in neuen Projekten, und er kommt in Abschnitt 5.
  2. Die Datei heißt .mjs. Dann gilt sie als Modul, egal was drumherum steht. So hält es der Kurs, bis die package.json dazukommt.
  3. Keins von beidem. Dann schaut Node in die Datei und entscheidet an der Syntax. Steht dort ein import, ein export oder ein await auf oberster Ebene, liest es sie als Modul.

Spiegelbildlich gibt es auch .cjs für eine CommonJS-Datei in einem Projekt, das sonst auf Module steht.

Der dritte Punkt ist neu, und in den Anleitungen stand jahrelang etwas anderes. Früher war ein import in einer .js ohne Eintrag ein harter Abbruch mit der Meldung SyntaxError: Cannot use import statement outside a module. Seit Node 22.7 schaut Node in solchen Fällen in die Datei, statt sie einfach als CommonJS zu lesen.

Verlassen kannst du dich darauf trotzdem nicht. Mit "type": "commonjs" ist das Nachsehen ganz abgeschaltet, und der alte Abbruch ist wieder da. Liegt daneben eine package.json, in der kein "type" steht, liest Node die Datei zweimal und schreibt eine Warnung auf den Fehlerkanal. Was passiert, wenn das Feld fehlt, steht in Lektion 5.1.

Wie Node im Terminal entscheidet

Läuft die Sandbox mit dem ersten Beispiel dieser Lektion, liegen mathe.mjs und index.mjs auf der Maschine. Nach cp index.mjs index.js läuft auch node index.js durch, mit denselben Zeilen, anderer Endung und ohne Eintrag irgendwo. Im Terminal stehen Hallo aus mathe.mjs, 42 und 5. Node hat den import gesehen und die Datei als Modul gelesen.

Mit echo '{"type": "commonjs"}' > package.json nimmst du Node die Entscheidung ab. Ein weiteres node index.js bringt dann den alten Fehler zurück, wörtlich, mit dem import in der Zeile darüber und einer Reihe Zirkumflexe darunter. Darüber steht eine Warnung, die gleich sagt, was fehlt. Ein node index.mjs läuft daneben weiter, denn die Endung schlägt den Eintrag.

Aufräumen geht mit rm index.js package.json. Nötig ist das aber nicht, denn beim Wechsel zu einem anderen Beispiel wird das Verzeichnis ohnehin geleert.

Die Endung im Import ist Pflicht

Diese Regel trifft vor allem, wer aus CommonJS oder aus einem Projekt mit Bundler kommt.

Ein Import ohne Endung
// In ESM fehlt hier die Endung .mjs, und das ist ein Fehler.
import { brutto } from "./preise";

console.log(brutto(100));

In CommonJS durftest du require("./preise") schreiben, und Node hat die Endung dazugeraten. In ESM rät es nicht. Der Pfad im Import ist eine Adresse, und eine Adresse ohne Endung zeigt auf nichts. Im Browser gilt dieselbe Regel, die stand schon im JavaScript-Kurs bei den Modulen.

Verwirrend ist das vor allem, weil du es in React-, Vue- oder Astro-Projekten dauernd ohne Endung siehst. Dort läuft aber ein Bundler dazwischen, der die Datei für dich sucht. Node hat keinen Bundler. Was du schreibst, wird gesucht.

In der Fehlermeldung im Beispiel stehen ERR_MODULE_NOT_FOUND und ein Pfad ohne Endung. Zusammen ist das ein ziemlich eindeutiges Zeichen.

Was jedes System besser kann

ESM kann await auf oberster Ebene, also außerhalb jeder Funktion.

Warten ganz oben
const antwort = await Promise.resolve("Das geht nur in ESM");

console.log(antwort);
console.log("require gibt es hier nicht:", typeof require);

Das ist praktischer, als es klingt. Konfiguration einlesen, eine Verbindung aufbauen, einen Wert holen, bevor der Rest startet, all das geht so ohne Umweg. In CommonJS bräuchtest du dafür eine async-Funktion, die du sofort selbst aufrufst.

In Lektion 1.3 fehlte require in der Namensliste, weil es nicht an globalThis hängt. Im selben Beispiel siehst du, dass es das Wort in einem ES-Modul gar nicht gibt.

CommonJS kann dafür mitten im Code laden. Ein require darf in einer Bedingung stehen und erst dann ausgeführt werden, wenn es wirklich gebraucht wird. Ein import darf das nicht. Er gehört auf die oberste Ebene der Datei und wird immer ausgeführt. Wer erst später laden will, nimmt die Funktionsform import(), die ein Promise zurückgibt und überall stehen darf.

ESM für Neues, CommonJS zum Lesen

Neue Projekte schreibe ich in ESM. Es ist der Standard der Sprache und läuft im Browser genauso wie in Node, und auch die meisten Werkzeuge kommen inzwischen ohne Probleme damit klar. CommonJS lese ich, wenn ich in ältere Projekte komme.

Zwei Systeme im selben Projekt zu mischen geht übrigens auch, ist aber ein eigenes kleines Thema voller Sonderfälle. Solange du eins von beidem durchziehst, begegnet es dir nicht.

In der Aufgabe holt sich eine fertige index.mjs drei Dinge aus preise.mjs, und dort fehlen die Exporte.

Zum Mitnehmen

export gibt heraus, import holt herein, und im Pfad steht immer die Endung. Ob eine Datei ein ES-Modul ist, sagen die Endung .mjs, type: module in der package.json oder zur Not die Syntax in der Datei.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.