remotion-dev/add-cli-option

Was macht add-cli-option?

Füge eine neue Remotion CLI- oder Konfigurationsoption hinzu, indem du eine AnyRemotionOption erstellst, das CLI-Parsing registrierst, Config-Setter verdrahtest und die Dokumentation aktualisierst. Verwende dies beim Hinzufügen oder Umwandeln von Befehlszeilen-Flags oder Remotion-Optionen.

Schritte

1. Erstelle eine AnyRemotionOption-Definition: Definiere die Option in einer neuen Datei unter packages/core/src/options/. Die Definition sollte den Typ, Standardwert, Beschreibung, CLI-Flag (falls zutreffend) und andere Metadaten enthalten.

2. Registriere das CLI-Parsing: Füge die Parsing-Logik für das CLI-Flag in der Datei packages/cli/src/parsing/ hinzu. Dies beinhaltet die Verwendung von yargs oder einem eigenen Parser, um das Flag aus der Befehlszeile zu lesen.

3. Verdrahte Config-Setter: Erstelle oder aktualisiere Config-Setter in packages/core/src/config/, um die Option sowohl über die CLI als auch über die Remotion-Konfigurationsdatei zu setzen. Stelle sicher, dass die Setter die Option korrekt in der globalen Konfiguration aktualisieren.

4. Aktualisiere die Dokumentation: Füge die neue Option in der entsprechenden Dokumentationsdatei unter packages/docs/docs/ hinzu. Dokumentiere das CLI-Flag, die Konfigurationsoption und ihre Verwendung.

5. Tests schreiben (optional): Füge Tests hinzu, um sicherzustellen, dass die Option korrekt funktioniert.

Beispiel

// packages/core/src/options/my-option.ts
export const myOption = new AnyRemotionOption({
  name: 'myOption',
  cliFlag: 'my-option',
  description: 'Meine benutzerdefinierte Option',
  defaultValue: false,
  type: 'boolean',
});

Hinweise

• Stelle sicher, dass die Option sowohl über die CLI als auch über die Konfigurationsdatei funktioniert.
• Verwende konsistente Namenskonventionen für CLI-Flags und Config-Schlüssel.
• Aktualisiere auch die TypeScript-Typdefinitionen, falls erforderlich.