remotion-dev/ajouter-option-cli

Que fait ajouter-option-cli ?

Ajoutez une nouvelle option CLI ou de configuration Remotion en créant un AnyRemotionOption, en enregistrant l'analyse CLI, en connectant les modificateurs de configuration et en mettant à jour la documentation. À utiliser lors de l'ajout ou de la conversion de drapeaux en ligne de commande ou d'options Remotion.

Étapes

1. Créer un fichier d'option dans le dossier packages/core/src/options/.
2. Définir un AnyRemotionOption avec les métadonnées appropriées (nom, description, type, valeur par défaut, etc.).
3. Enregistrer l'analyse CLI dans le fichier packages/cli/src/parse-command-line.ts.
4. Connecter les modificateurs de configuration dans packages/core/src/config.ts pour que l'option soit accessible via l'API config.
5. Mettre à jour la documentation dans packages/docs/docs/ (si applicable).

Exemple

// packages/core/src/options/my-option.ts
const myOption = new AnyRemotionOption({
  name: 'myOption',
  cliFlag: 'my-option',
  description: 'Ma nouvelle option',
  type: 'string',
  defaultValue: 'default',
});

Notes

• Assurez-vous que les noms des options sont cohérents et suivent les conventions de Remotion.
• Testez l'option via la ligne de commande et l'API de configuration après l'ajout.