remotion-dev/remotion

Make entry point optional #1391

JonnyBurger posted onGitHub

šŸŽƒ This issue is part of our Hacktoberfest campaign! šŸ“š Read more about Hacktoberfest here šŸ•› This issue is currently assigned to @Pompette šŸ’° Thanks to CodeChem for sponsoring this issue! āš ļø This issue can only be taken once #1377 is finished!

Each Remotion command starts with npx remotion [command] [entry-point]:

npx remotion preview src/index.tsx
npx remotion render src/index.tsx
npx remotion benchmark src/index.tsx

The goal is to make it that if you omit the entry point, Remotion will detect it itself:

Rules:

  • First priority: If the entry point is specified, use it.
  • Second priority: Add a new rule in the config file: Config.Preview.setEntryPoint('src/index.tsx') (subject to change) and check if it is set. If so, use it
  • Third priority: Look for common paths like src/index.tsx, src/index.ts, src/index.js, remotion/index.js. If that is the case, use Log.verbose to print out the path that Remotion has decided on
  • Fourth priority: Fail because entry point could not be determined.

Acceptance criteria

  • Implement logic according to rules above
  • Update the CLI section of the documentation to reflect that you don't have to pass the entry point anymore and document the rules of order.

Hi @JonnyBurger, I would like to work on this issue if possible.

posted by ayatkyo over 2 years ago

@ayatkyo Yes, however note the requirement that this issue can only be started once #1377 is done. I'll ask you to confirm again once that is the case!

posted by JonnyBurger over 2 years ago

@remotion-dev has funded $167.00 to this issue.


posted by issuehunt-app[bot] over 2 years ago

@ayatkyo has taken another issue for now, so it is free now. Still need to wait for the other one to get merged though.

posted by JonnyBurger over 2 years ago

Hey @JonnyBurger , if it's still available I'd like to work on this one :) !

posted by Pompette over 2 years ago

@Pompette Assigned! You just have to wait for #1377 to get solved.

posted by JonnyBurger over 2 years ago

Thanks @JonnyBurger , but I'm not sure to understand if the issue #1377 is taken by someone regarding your last comment on it. Is it currently WIP ?

posted by Pompette over 2 years ago

@Pompette As of 2 days ago, the issue is still active! We chatted on Discord about it

posted by JonnyBurger over 2 years ago

@Pompette The PR that was required for this issue to get kicked off has now been merged! šŸŽ‰ Do you want to work on this issue?

posted by JonnyBurger over 2 years ago

Hi @JonnyBurger, I'd like to work on this issue if it's available :)

posted by JRavi2 over 2 years ago

@JRavi2 Giving it to you! Good luck :)

posted by JonnyBurger over 2 years ago

@jonnyburger has rewarded $150.30 to @jravi2. See it on IssueHunt

  • :moneybag: Total deposit: $167.00
  • :tada: Repository reward(0%): $0.00
  • :wrench: Service fee(10%): $16.70
posted by issuehunt-app[bot] over 2 years ago

Fund this Issue

$167.00
Rewarded

Rewarded pull request

Recent activities

jravi2 was rewarded by jonnyburger for remotion-dev/remotion# 1391
over 2 years ago
jonnyburger submitted an output to  remotion-dev/ remotion# 1391
over 2 years ago