V3 experiments - Githubissues

njoyard commented 1 year ago

Complete API rewrite.

New dev tooling

Node 18+ only
yarn
Typescript
GH actions for CI
ava for testing, with sinon for mocks, c8 and coveralls for coverage
prettier

New API principles

Zero dependencies (for users, of course we need devDependencies for development)
Completely incompatible with fluent-ffmpeg 2.x. I'm still debating whether to include a compatibility layer that emits deprecation warnings, but that would be about the same work as rewriting 2.x from scratch.
Natively typescript
There is usually only one way to perform a given operation. No more methods with 42 aliases, or arguments that can be strings/arrays/objects and are a pain to validate.
Replaced chaining with options object

await ffmpeg({
  input: 'path/to/input.webm',
  output: {
    target: 'path/to/output.mp4',
    video: { codec: 'h264', bitrate: '1M' },
    audio: false
  }
}).run()

Dropped features

The following features were not reimplemented:

flvtool/flvmeta specifics; those should be mostly unused by now, people can still either use v2 or run flvtool/flvmeta themselves
avconv/avprobe compatibility; libav is dead

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 6889204749

1040 of 1228 (84.69%) changed or added relevant lines in 15 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-6.1%) to 84.691%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/capabilities.ts	53	71	74.65%
src/process.ts	152	175	86.86%
src/command.ts	64	94	68.09%
src/main.ts	0	32	0.0%
src/utils/parsing.ts	231	316	73.1%
<!--	Total:	1040	1228	84.69%	-->