@electron/fiddle-core


Run fiddles from anywhere, on any Electron release

CLI

``sh


fiddle-core run ver (gist | repo URL | folder)

🏁 Done bisecting
🟢 passed 12.0.1
🔴 failed 12.0.2
Commits between versions:
↔ https://github.com/electron/electron/compare/v12.0.1...v12.0.2
Done in 28.19s.
`

API

$3

`ts
import { Runner } from '@electron/fiddle-core';

const runner = await Runner.create();
const { status } = await runner.run('13.1.7', '/path/to/fiddle');
console.log(status);
`

$3

`ts
import { Runner } from '@electron/fiddle-core';

const runner = await Runner.create();

// use a specific Electron version to run code from a local folder
const result = await runner.run('13.1.7', '/path/to/fiddle');

// use a specific Electron version to run code from a github gist
const result = await runner.run('14.0.0-beta.17', '642fa8daaebea6044c9079e3f8a46390');

// use a specific Electron version to run code from a git repo
const result = await runner.run('15.0.0-alpha.1', 'https://github.com/my/repo.git');

// use a specific Electron version to run code from iterable filename/content pairs
const files = new Map([['main.js', '"use strict";']]);
const result = await runner.run('15.0.0-alpha.1', files);

// bisect a regression test across a range of Electron versions
const result = await runner.bisect('10.0.0', '13.1.7', path_or_gist_or_git_repo);

// run with Windows MSIX identity (Windows only)
// This registers Electron as a sparse MSIX package, giving it a Windows app identity
const result = await runner.run('30.0.0', fiddle, { runWithIdentity: true });

// see also Runner.spawn() in Advanced Use
`

$3

On Windows, you can run Electron with a sparse MSIX package identity. This gives Electron a Windows app identity, which is required for certain Windows features.

`ts
import { Runner } from '@electron/fiddle-core';

const runner = await Runner.create();

// Run fiddle with Windows MSIX identity
const result = await runner.run('30.0.0', fiddle, {
runWithIdentity: true,
});
`

When runWithIdentity is true, fiddle-core will:
1. Generate an AppxManifest.xml in the Electron installation directory
2. Register Electron as a sparse MSIX package using Add-AppxPackage
3. Run Electron via its registered execution alias

$3

`ts
import { Installer, ProgressObject } from '@electron/fiddle-core';

const installer = new Installer();
installer.on('state-changed', ({version, state}) => {
console.log(Version "${version}" state changed: "${state}");
});

// download a version of electron
await installer.ensureDownloaded('12.0.15');
// expect(installer.state('12.0.5').toBe('downloaded');

// download a version with callback
const callback = (progress: ProgressObject) => {
const percent = progress.percent * 100;
console.log(Current download progress %: ${percent.toFixed(2)});
};
await installer.ensureDownloaded('12.0.15', {
progressCallback: callback,
});

// download a version with a specific mirror
const npmMirrors = {
electronMirror: 'https://npmmirror.com/mirrors/electron/',
electronNightlyMirror: 'https://npmmirror.com/mirrors/electron-nightly/',
},

await installer.ensureDownloaded('12.0.15', {
mirror: npmMirrors,
});

// remove a download
await installer.remove('12.0.15');
// expect(installer.state('12.0.15').toBe('not-downloaded');

// install a specific version for the runner to use
const exec = await installer.install('11.4.10');

// Installing with callback and custom mirrors
await installer.install('11.4.10', {
progressCallback: callback,
mirror: npmMirrors,
});
// expect(installer.state('11.4.10').toBe('installed');
// expect(fs.accessSync(exec, fs.constants.X_OK)).toBe(true);
`

$3

`ts
import { ElectronVersions } from '@electron/fiddle-core';

// - querying specific versions
const elves = await ElectronVersions.create();
// expect(elves.isVersion('12.0.0')).toBe(true);
// expect(elves.isVersion('12.99.99')).toBe(false);
const { versions } = elves;
// expect(versions).find((ver) => ver.version === '12.0.0').not.toBeNull();
// expect(versions[versions.length - 1]).toStrictEqual(elves.latest);

// - supported major versions
const { supportedMajors } = elves;
// expect(supportedMajors.length).toBe(4);

// - querying prerelease branches
const { supportedMajors, prereleaseMajors } = elves;
const newestSupported = Math.max(...supportedMajors);
const oldestPrerelease = Math.min(...prereleaseMajors);
// expect(newestSupported + 1).toBe(oldestPrerelease);

// - get all releases in a range
let range = releases.inRange('12.0.0', '12.0.15');
// expect(range.length).toBe(16);
// expect(range.shift().version).toBe('12.0.0');
// expect(range.pop().version).toBe('12.0.15');

// - get all 10-x-y releases
range = releases.inMajor(10);
// expect(range.length).toBe(101);
// expect(range.shift().version).toBe('10.0.0-nightly.20200209');
// expect(range.pop().version).toBe('10.4.7');
`

Advanced Use

$3

`ts
import { Runner } from '@electron/fiddle-core';

// third argument is same as node.spawn()'s opts
const child = await runner.spawn('12.0.1', fiddle, nodeSpawnOpts);

// see also Runner.run() and Runner.bisect() above
`

$3

`ts
import { Runner } from '@electron/fiddle-core';

const runner = await Runner.create();
const result = await runner.run('/path/to/electron/build', fiddle);
`

$3

`ts
import { Paths, Runner } from '@electron/fiddle-core';

const paths: Paths = {
// where to store zipfiles of downloaded electron versions
electronDownloads: '/tmp/my/electron-downloads',

// where to install an electron version to be used by the Runner
electronInstall: '/tmp/my/electron-install',

// where to save temporary copies of fiddles
fiddles: '/tmp/my/fiddles',

// where to save releases fetched from online
versionsCache: '/tmp/my/releases.json',
});

const runner = await Runner.create({ paths });
`

$3

Runner will do this work for you; but if you want finer-grained control
over the lifecycle of your Fiddle objects, you can instantiate them yourself:

`ts
import { FiddleFactory } from '@electron/fiddle-core';

const factory = new FiddleFactory();

// load a fiddle from a local directory
const fiddle = await factory.from('/path/to/fiddle'));

// ...or from a gist
const fiddle = await factory.from('642fa8daaebea6044c9079e3f8a46390'));

// ...or from a git repo
const fiddle = await factory.from('https://github.com/my/testcase.git'));

// ...or from an iterable of key / value entries
const fiddle = await factory.from([
['main.js', '"use strict";'],
]);
``