microbundle/src/index.js at master · developit/microbundle · GitHub

History

725 lines (649 loc) · 20.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

import fs from 'fs';

import { resolve, relative, dirname, basename, extname } from 'path';

import camelCase from 'camelcase';

import escapeStringRegexp from 'escape-string-regexp';

import { blue, yellow, red } from 'kleur';

import { map, series } from 'asyncro';

import glob from 'tiny-glob/sync';

import autoprefixer from 'autoprefixer';

import { rollup, watch } from 'rollup';

import builtinModules from 'builtin-modules';

import resolveFrom from 'resolve-from';

import commonjs from '@rollup/plugin-commonjs';

import babel from '@rollup/plugin-babel';

import customBabel from './lib/babel-custom';

import nodeResolve from '@rollup/plugin-node-resolve';

import { terser } from 'rollup-plugin-terser';

import { visualizer } from 'rollup-plugin-visualizer';

import alias from '@rollup/plugin-alias';

import postcss from 'rollup-plugin-postcss';

import typescript from 'rollup-plugin-typescript2';

import json from '@rollup/plugin-json';

import OMT from '@surma/rollup-plugin-off-main-thread';

import logError from './log-error';

import {

EXTENSION,

isDir,

isFile,

isTruthy,

stdout,

removeScope,

} from './utils';

import { getSizeInfo } from './lib/compressed-size';

import { normalizeMinifyOptions } from './lib/terser';

import {

parseAliasArgument,

parseMappingArgument,

toReplacementExpression,

} from './lib/option-normalization';

import { getConfigFromPkgJson, getName } from './lib/package-info';

import { shouldCssModules, cssModulesConfig } from './lib/css-modules';

import { EOL } from 'os';

import MagicString from 'magic-string';

// Extensions to use when resolving modules

const EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx', '.es6', '.es', '.mjs'];

const WATCH_OPTS = {

};

export default async function microbundle(inputOptions) {

let options = { ...inputOptions };

options.cwd = resolve(process.cwd(), inputOptions.cwd);

const cwd = options.cwd;

const { hasPackageJson, pkg } = await getConfigFromPkgJson(cwd);

options.pkg = {

...pkg,

...pkg.publishConfig,

};

const { finalName, pkgName } = getName({

pkgName: options.pkg.name,

amdName: options.pkg.amdName,

hasPackageJson,

cwd,

});

options.name = finalName;

options.pkg.name = pkgName;

if (options.sourcemap === 'inline') {

console.log(

'Warning: inline sourcemaps should only be used for debugging purposes.',

);

} else if (options.sourcemap === 'false') {

options.sourcemap = false;

} else if (options.sourcemap !== false) {

options.sourcemap = true;

}

options.input = await getInput({

entries: options.entries,

cwd,

source: options.pkg.source,

module: options.pkg.module,

});

options.output = await getOutput({

cwd,

output: options.output,

pkgMain: options.pkg.main,

pkgName: options.pkg.name,

});

options.entries = await getEntries({

cwd,

input: options.input,

});

options.multipleEntries = options.entries.length > 1;

let formats = (options.format || options.formats).split(',');

// de-dupe formats and convert "esm" to "es":

formats = Array.from(new Set(formats.map(f => (f === 'esm' ? 'es' : f))));

// always compile cjs first if it's there:

formats.sort((a, b) => (a === 'cjs' ? -1 : a > b ? 1 : 0));

let steps = [];

for (let i = 0; i < options.entries.length; i++) {

for (let j = 0; j < formats.length; j++) {

steps.push(

createConfig(options, options.entries[i], formats[j], j === 0),

);

}

if (options.watch) {

return doWatch(options, cwd, steps);

}

let cache;

let out = await series(

steps.map(config => async () => {

const { inputOptions, outputOptions } = config;

if (inputOptions.cache !== false) {

inputOptions.cache = cache;

}

let bundle = await rollup(inputOptions);

cache = bundle;

await bundle.write(outputOptions);

return await config._sizeInfo;

}),

);

const targetDir = relative(cwd, dirname(options.output)) || '.';

const sourceExist = options.input.length > 0;

const banner = sourceExist

? blue(`Build "${options.pkg.name}" to ${targetDir}:`)

: red(`Error: No entry module found for "${options.pkg.name}"`);

return {

output: `${banner}\n${out.join('\n')}`,

};

}

function doWatch(options, cwd, steps) {

const { onStart, onBuild, onError } = options;

return new Promise((resolve, reject) => {

const targetDir = relative(cwd, dirname(options.output));

stdout(blue(`Watching source, compiling to ${targetDir}:`));

const watchers = steps.reduce((acc, options) => {

acc[options.inputOptions.input] = watch(

Object.assign(

{

output: options.outputOptions,

watch: WATCH_OPTS,

options.inputOptions,

).on('event', e => {

if (e.code === 'START') {

if (typeof onStart === 'function') {

onStart(e);

}

if (e.code === 'ERROR') {

logError(e.error);

if (typeof onError === 'function') {

onError(e);

}

if (e.code === 'END') {

if (options._sizeInfo) {

options._sizeInfo.then(text => {

stdout(`Wrote ${text.trim()}`);

});

}

if (typeof onBuild === 'function') {

onBuild(e);

}

});

return acc;

}, {});

resolve({ watchers });

});

}

async function jsOrTs(cwd, filename) {

const extension = (await isFile(resolve(cwd, filename + '.ts')))

? '.ts'

: (await isFile(resolve(cwd, filename + '.tsx')))

? '.tsx'

: '.js';

return resolve(cwd, `${filename}${extension}`);

}

async function getInput({ entries, cwd, source, module }) {

const input = [];

[]

.concat(

entries && entries.length

? entries

: (source &&

(Array.isArray(source) ? source : [source]).map(file =>

resolve(cwd, file),

)) ||

((await isDir(resolve(cwd, 'src'))) &&

(await jsOrTs(cwd, 'src/index'))) ||

(await jsOrTs(cwd, 'index')) ||

module,

)

.map(file => glob(file))

.forEach(file => input.push(...file));

return input;

}

async function getOutput({ cwd, output, pkgMain, pkgName }) {

let main = resolve(cwd, output || pkgMain || 'dist');

if (!main.match(/\.[a-z]+$/) || (await isDir(main))) {

main = resolve(main, `${removeScope(pkgName)}.js`);

}

return main;

}

function getDeclarationDir({ options, pkg }) {

const { cwd, output } = options;

let result = output;

if (pkg.types || pkg.typings) {

result = pkg.types || pkg.typings;

result = resolve(cwd, result);

}

result = dirname(result);

return result;

}

async function getEntries({ input, cwd }) {

let entries = (

await map([].concat(input), async file => {

file = resolve(cwd, file);

if (await isDir(file)) {

file = resolve(file, 'index.js');

}

return file;

})

).filter((item, i, arr) => arr.indexOf(item) === i);

return entries;

}

function replaceName(filename, name) {

return resolve(

dirname(filename),

name + basename(filename).replace(/^[^.]+/, ''),

);

}

function walk(exports, includeDefault) {

if (!exports) return null;

if (typeof exports === 'string') return exports;

let p = exports['.'] || exports.import || exports.module;

if (!p && includeDefault) p = exports.default;

return walk(p, includeDefault);

}

function getMain({ options, entry, format }) {

const { pkg } = options;

const pkgMain = options['pkg-main'];

const pkgTypeModule = pkg.type === 'module';

if (!pkgMain) {

return options.output;

}

let mainNoExtension = options.output;

if (options.multipleEntries) {

let name = entry.match(new RegExp(/([\\/])index/.source + EXTENSION.source))

? mainNoExtension

: entry;

mainNoExtension = resolve(dirname(mainNoExtension), basename(name));

}

mainNoExtension = mainNoExtension.replace(EXTENSION, '');

const mainsByFormat = {};

mainsByFormat.es = replaceName(

pkg.module && !pkg.module.match(/src\//)

? pkg.module

: pkg['jsnext:main'] || (pkgTypeModule ? 'x.esm.js' : 'x.esm.mjs'),

mainNoExtension,

);

mainsByFormat.modern = replaceName(

(pkg.exports && walk(pkg.exports, pkgTypeModule)) ||

(pkg.syntax && pkg.syntax.esmodules) ||

pkg.esmodule ||

(pkgTypeModule ? 'x.modern.js' : 'x.modern.mjs'),

mainNoExtension,

);

mainsByFormat.cjs = replaceName(

pkg['cjs:main'] || (pkgTypeModule ? 'x.cjs' : 'x.js'),

mainNoExtension,

);

mainsByFormat.umd = replaceName(

pkg['umd:main'] || pkg.unpkg || 'x.umd.js',

mainNoExtension,

);

return mainsByFormat[format] || mainsByFormat.cjs;

}

// shebang cache map because the transform only gets run once

const shebang = {};

function createConfig(options, entry, format, writeMeta) {

let { pkg } = options;

/** @type {(string|RegExp)[]} */

let external = ['dns', 'fs', 'path', 'url'];

/** @type {Record<string, string>} */

let outputAliases = {};

const moduleAliases = options.alias ? parseAliasArgument(options.alias) : [];

const aliasIds = moduleAliases.map(alias => alias.find);

// We want to silence rollup warnings for node builtins as we rollup-node-resolve threats them as externals anyway

// @see https://github.com/rollup/plugins/tree/master/packages/node-resolve/#resolving-built-ins-like-fs

if (options.target === 'node') {

external = [/node:.*/].concat(builtinModules);

}

const peerDeps = Object.keys(pkg.peerDependencies || {});

if (options.external === 'none') {

// bundle everything (external=[])

} else if (options.external) {

external = external.concat(peerDeps).concat(

// CLI --external supports regular expressions:

options.external.split(',').map(str => new RegExp(str)),

);

} else {

external = external

.concat(peerDeps)

.concat(Object.keys(pkg.dependencies || {}));

}

let globals = external.reduce((globals, name) => {

// Use raw value for CLI-provided RegExp externals:

if (name instanceof RegExp) name = name.source;

// valid JS identifiers are usually library globals:

if (name.match(/^[a-z_$][a-z0-9_\-$]*$/)) {

globals[name] = camelCase(name);

}

return globals;

}, {});

if (options.globals && options.globals !== 'none') {

globals = Object.assign(globals, parseMappingArgument(options.globals));

}

let defines = {};

if (options.define) {

defines = Object.assign(

defines,

parseMappingArgument(options.define, toReplacementExpression),

);

}

const modern = format === 'modern';

// let rollupName = safeVariableName(basename(entry).replace(/\.js$/, ''));

let nameCache = {};

const bareNameCache = nameCache;

// Support "minify" field and legacy "mangle" field via package.json:

const rawMinifyValue = options.pkg.minify || options.pkg.mangle || {};

let minifyOptions = typeof rawMinifyValue === 'string' ? {} : rawMinifyValue;

const getNameCachePath =

typeof rawMinifyValue === 'string'

? () => resolve(options.cwd, rawMinifyValue)

: () => resolve(options.cwd, 'mangle.json');

const useTypescript = extname(entry) === '.ts' || extname(entry) === '.tsx';

const emitDeclaration =

options.generateTypes == null

? !!(pkg.types || pkg.typings)

: options.generateTypes;

const useWorkerLoader = options.workers !== false;

const escapeStringExternals = ext =>

ext instanceof RegExp ? ext.source : escapeStringRegexp(ext);

const externalPredicate = new RegExp(

`^(${external.map(escapeStringExternals).join('|')})($|/)`,

);

const externalTest =

external.length === 0 ? id => false : id => externalPredicate.test(id);

let endsWithNewLine = false;

let nameCacheIndentTabs = false;

function loadNameCache() {

try {

const data = fs.readFileSync(getNameCachePath(), 'utf8');

nameCacheIndentTabs = /^\t+/gm.test(data);

endsWithNewLine = data.endsWith(EOL);

nameCache = JSON.parse(data);

// mangle.json can contain a "minify" field, same format as the pkg.mangle:

if (nameCache.minify) {

minifyOptions = Object.assign(

{},

minifyOptions || {},

nameCache.minify,

);

}

} catch (e) {}

}

loadNameCache();

normalizeMinifyOptions(minifyOptions);

if (nameCache === bareNameCache) nameCache = null;

/** @type {false | import('rollup').RollupCache} */

let cache;

if (modern) cache = false;

const absMain = resolve(options.cwd, getMain({ options, entry, format }));

const outputDir = dirname(absMain);

const outputEntryFileName = basename(absMain);

// Warn about the (somewhat) breaking change in #950

if (format === 'es' && !pkg.module && outputEntryFileName.endsWith('.mjs')) {

stdout(

yellow(

'Warning: your package.json does not specify {"type":"module"}. Microbundle assumes this is a CommonJS package and is generating ES Modules with the ".mjs" file extension.',

);

}

let config = {

/** @type {import('rollup').InputOptions} */

inputOptions: {

// disable Rollup's cache for modern builds to prevent re-use of legacy transpiled modules:

cache,

input: entry,

external: id => {

if (id === 'babel-plugin-transform-async-to-promises/helpers') {

return false;

}

if (aliasIds.indexOf(id) >= 0) {

return false;

}

return externalTest(id);

onwarn(warning, warn) {

// https://github.com/rollup/rollup/blob/0fa9758cb7b1976537ae0875d085669e3a21e918/src/utils/error.ts#L324

if (warning.code === 'UNRESOLVED_IMPORT') {

stdout(

`Failed to resolve the module ${warning.source} imported by ${warning.importer}` +

`\nIs the module installed? Note:` +

`\n ↳ to inline a module into your bundle, install it to "devDependencies".` +

`\n ↳ to depend on a module via import/require, install it to "dependencies".`,

);

return;

} else if (warning.code === 'THIS_IS_UNDEFINED') return;

warn(warning);

treeshake: {

propertyReadSideEffects: false,

plugins: []

.concat(

postcss({

plugins: [autoprefixer()],

autoModules: shouldCssModules(options),

modules: cssModulesConfig(options),

// only write out CSS for the first bundle (avoids pointless extra files):

inject: false,

extract:

!!writeMeta &&

options.css !== 'inline' &&

absMain.replace(EXTENSION, '.css'),

minimize: options.compress,

sourceMap: options.sourcemap && options.css !== 'inline',

}),

moduleAliases.length > 0 &&

alias({

// @TODO: this is no longer supported, but didn't appear to be required?

// resolve: EXTENSIONS,

entries: moduleAliases,

}),

nodeResolve({

mainFields: ['module', 'jsnext', 'main'],

browser: options.target !== 'node',

exportConditions: [options.target === 'node' ? 'node' : 'browser'],

// defaults + .jsx

extensions: ['.mjs', '.js', '.jsx', '.json', '.node'],

preferBuiltins: options.target === 'node',

}),

commonjs({

// use a regex to make sure to include eventual hoisted packages

include: /\/node_modules\//,

esmExternals: false,

requireReturnsDefault: 'namespace',

}),

json(),

{

// We have to remove shebang so it doesn't end up in the middle of the code somewhere

transform: code => ({

code: code.replace(/^#![^\n]*/, bang => {

shebang[options.name] = bang;

}),

map: null,

}),

(useTypescript || emitDeclaration) &&

typescript({

cwd: options.cwd,

typescript: require(resolveFrom.silent(

options.cwd,

'typescript',

) || 'typescript'),

cacheRoot: `./node_modules/.cache/.rts2_cache_${format}`,

useTsconfigDeclarationDir: true,

tsconfigDefaults: {

compilerOptions: {

sourceMap: options.sourcemap,

declaration: options.generateTypes !== false,

allowJs: true,

emitDeclarationOnly: options.generateTypes && !useTypescript,

...(options.generateTypes !== false && {

declarationDir: getDeclarationDir({ options, pkg }),

}),

jsx: 'preserve',

jsxFactory: options.jsx,

jsxFragmentFactory: options.jsxFragment,

files: options.entries,

tsconfig: options.tsconfig,

tsconfigOverride: {

compilerOptions: {

module: 'ESNext',

target: 'esnext',

}),

// if defines is not set, we shouldn't run babel through node_modules

isTruthy(defines) &&

babel({

babelHelpers: 'bundled',

babelrc: false,

compact: false,

configFile: false,

include: 'node_modules/**',

plugins: [

[

require.resolve('babel-plugin-transform-replace-expressions'),

{ replace: defines },

}),

customBabel()({

babelHelpers: 'bundled',

extensions: EXTENSIONS,

// use a regex to make sure to exclude eventual hoisted packages

passPerPreset: true, // @see https://babeljs.io/docs/en/options#passperpreset

custom: {

defines,

modern,

compress: options.compress !== false,

targets: options.target === 'node' ? { node: '12' } : undefined,

pragma: options.jsx,

pragmaFrag: options.jsxFragment,

typescript: !!useTypescript,

jsxImportSource: options.jsxImportSource || false,

}),

options.compress !== false && [

terser({

compress: Object.assign(

{

keep_infinity: true,

pure_getters: true,

// Ideally we'd just get Terser to respect existing Arrow functions...

// unsafe_arrows: true,

passes: 10,

typeof minifyOptions.compress === 'boolean'

? minifyOptions.compress

: minifyOptions.compress || {},

format: {

// By default, Terser wraps function arguments in extra parens to trigger eager parsing.

// Whether this is a good idea is way too specific to guess, so we optimize for size by default:

wrap_func_args: false,

comments: /^\s*([@#]__[A-Z]+__\s*$|@cc_on)/,

preserve_annotations: true,

module: modern,

ecma: modern ? 2017 : 5,

toplevel: modern || format === 'cjs' || format === 'es',

mangle:

typeof minifyOptions.mangle === 'boolean'

? minifyOptions.mangle

: Object.assign({}, minifyOptions.mangle || {}),

nameCache,

}),

nameCache && {

// before hook

options: loadNameCache,

// after hook

writeBundle() {

if (writeMeta && nameCache) {

let filename = getNameCachePath();

let json = JSON.stringify(

nameCache,

null,

nameCacheIndentTabs ? '\t' : 2,

);

if (endsWithNewLine) json += EOL;

fs.writeFile(filename, json, () => {});

}

options.visualize && visualizer(),

// NOTE: OMT only works with amd and esm

// Source: https://github.com/surma/rollup-plugin-off-main-thread#config

useWorkerLoader && (format === 'es' || modern) && OMT(),

/** @type {import('rollup').Plugin} */

({

// Rollup 2 injects globalThis, which is nice, but doesn't really make sense for Microbundle.

// Only ESM environments necessitate globalThis, and UMD bundles can't be properly loaded as ESM.

// So we remove the globalThis check, replacing it with `this||self` to match Rollup 1's output:

renderChunk(code, chunk, opts) {

if (opts.format === 'umd') {

// Can swap this out with MagicString.replace() when we bump it:

// https://github.com/developit/microbundle/blob/f815a01cb63d90b9f847a4dcad2a64e6b2f8596f/src/index.js#L657-L671

const s = new MagicString(code);

const minified = code.match(

/([a-zA-Z$_]+)="undefined"!=typeof globalThis\?globalThis:(\1\|\|self)/,

);

if (minified) {

s.overwrite(

minified.index,

minified.index + minified[0].length,

minified[2],

);

}

const unminified = code.match(

/(global *= *)typeof +globalThis *!== *['"]undefined['"] *\? *globalThis *: *(global *\|\| *self)/,

);

if (unminified) {

s.overwrite(

unminified.index,

unminified.index + unminified[0].length,

unminified[1] + unminified[2],

);

}

return {

code: s.toString(),

map: s.generateMap({ hires: true }),

};

}

// Grab size info before writing files to disk:

writeBundle(_, bundle) {

config._sizeInfo = Promise.all(

Object.values(bundle).map(({ code, fileName }) => {

if (code) {

return getSizeInfo(code, fileName, options.raw);

}

}),

).then(results => results.filter(Boolean).join('\n'));

}),

)

.filter(Boolean),

/** @type {import('rollup').OutputOptions} */

outputOptions: {

paths: outputAliases,

globals,

strict: options.strict === true,

freeze: false,

esModule: false,

sourcemap: options.sourcemap,

get banner() {

return shebang[options.name];

format: modern ? 'es' : format,

extend: /^global\./.test(options.name),

dir: outputDir,

entryFileNames: outputEntryFileName,

exports: 'auto',

};

return config;

}

microbundle/src/index.js at master · developit/microbundle · GitHub

Expand file tree

Breadcrumbs

index.js

Latest commit

History

Breadcrumbs

index.js

File metadata and controls