fent / node-ytdl-core

YouTube video downloader in javascript.
MIT License
4.53k stars 803 forks source link

ESModules? #652

Open jonahsnider opened 4 years ago

jonahsnider commented 4 years ago

I'd like to use certain functions from the package (mostly just the util functions for validation) in a frontend Next.js app. Since the package is currently being exported using CommonJS, no tree-shaking can occur.

This means anyone who visits the site would download the entire ytdl-core package even though only a small fraction of it is being used.

If ytdl-core offered ECMAScript modules exports (in addition to CommonJS) bundle sizes can be optimized on the web.

fent commented 4 years ago

does import util from 'ytdl-core/lib/util work?

jonahsnider commented 4 years ago

I believe that'll work better, now it's importing less code, but still being wasteful. Unfortunately doing this breaks TypeScript compilation:

Could not find a declaration file for module 'ytdl-core/lib/util'. '/usr/src/project/node_modules/ytdl-core/lib/util.js' implicitly has an 'any' type.
  Try `npm install @types/ytdl-core` if it exists or add a new declaration (.d.ts) file containing `declare module 'ytdl-core/lib/util';`

A hacky fix can be done like this:

import {getVideoID as _getVideoID, validateURL as _validateURL} from 'ytdl-core';
// @ts-ignore
import ytdlUtil from 'ytdl-core/lib/util';

const {validateURL, getVideoID} = ytdlUtil as {validateURL: typeof _validateURL; getVideoID: typeof _getVideoID};
fent commented 4 years ago

ah, well I plan on converting this library to ts in the future, which will generate definitions for each source file

otherwise, there's this guide https://nodejs.org/api/esm.html#esm_dual_commonjs_es_module_packages

jonahsnider commented 4 years ago

A rewrite seems like the only feasible way to do this. Looking forward to when that's released. You might find this useful for getting started with that.