Skip to content
Permalink
Browse files

feat(generic): expose top level methods as JS APIs

ISSUES CLOSED: #54
  • Loading branch information
MarshallOfSound authored and malept committed Jan 1, 2017
1 parent 898de23 commit 93fb48f56c6f002b982617e3a246d8335d828912
@@ -0,0 +1,21 @@
{
"source": "./src/api",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-importpath-plugin",
"option": {
"replaces": [
{
"from": ".js",
"to": ""
},
{
"from": "api/",
"to": "dist/api/"
}
]
}
}
]
}
@@ -1,2 +1,3 @@
dist
node_modules
docs
@@ -3,7 +3,7 @@
"version": "2.4.0",
"description": "A complete tool for building modern Electron applications",
"repository": "https://github.com/electron-userland/electron-forge",
"main": "index.js",
"main": "dist/api/index.js",
"bin": {
"electron-forge": "dist/electron-forge.js",
"forge": "dist/electron-forge.js"
@@ -12,6 +12,7 @@
"build": "gulp build",
"precommit": "npm run lint",
"commit": "git-cz",
"docs": "esdoc",
"lint": "eslint src test gulpfile.babel.js",
"prepublish": "gulp build",
"pretest": "gulp build",
@@ -33,6 +34,8 @@
"chai": "^3.5.0",
"commitizen": "^2.8.6",
"cz-customizable": "4.0.0",
"esdoc": "^0.5.1",
"esdoc-importpath-plugin": "^0.1.0",
"eslint": "^3.7.1",
"eslint-config-airbnb-base": "^8.0.0",
"eslint-plugin-import": "^1.16.0",
@@ -0,0 +1,215 @@
import debug from 'debug';
import fs from 'fs-promise';
import inquirer from 'inquirer';
import path from 'path';
import { spawn as yarnOrNPMSpawn, hasYarn } from 'yarn-or-npm';

import initGit from '../init/init-git';
import { deps, devDeps } from '../init/init-npm';

import asyncOra from '../util/ora-handler';
import installDepList from '../util/install-dependencies';
import readPackageJSON from '../util/read-package-json';

const d = debug('electron-forge:import');

/**
* @typedef {Object} ImportOptions
* @property {string} [dir=process.cwd()] The path to the module to import
* @property {boolean} [interactive=false] Boolean, whether to use sensible defaults or prompt the user visually.
*/

/**
* Attempts to import a given module directory to the electron-forge standard.
*
* - Replaces the electron prebuilt with electron-compile
* - Sets up git and the correct NPM dependencies
* - Puts in a template forge config
*
* @param {ImportOptions} options - Options for the Import method
* @return {Promise} Will resolve when the import process is complete
*/
export default async (providedOptions = {}) => {
const { dir, interactive } = Object.assign({
dir: process.cwd(),
interactive: false,
}, providedOptions);
asyncOra.interactive = interactive;

d(`Attempting to import project in: ${dir}`);
if (!await fs.exists(dir) || !await fs.exists(path.resolve(dir, 'package.json'))) {
console.error(`We couldn't find a project in: ${dir}`.red);
process.exit(1);
}

const confirm = !interactive || (await inquirer.createPromptModule()({
type: 'confirm',
name: 'confirm',
message: `WARNING: We will now attempt to import: "${dir}". This will involve modifying some files, are you sure you want to continue?`,
})).confirm;
if (!confirm) {
process.exit(1);
}

await initGit(dir);

let packageJSON = await readPackageJSON(dir);
if (packageJSON.config && packageJSON.config.forge) {
console.warn('It looks like this project is already configured for "electron-forge"'.green);
const shouldContinue = !interactive || (await inquirer.createPromptModule()({
type: 'confirm',
name: 'shouldContinue',
message: 'Are you sure you want to continue?',
})).shouldContinue;
if (!shouldContinue) {
process.exit(0);
}
}

const shouldChangeMain = interactive ? (await inquirer.createPromptModule()({
type: 'confirm',
name: 'shouldChangeMain',
message: 'Do you want us to change the "main" attribute of your package.json? If you are currently using babel and pointing to a "build" directory say yes.', // eslint-disable-line
})).shouldChangeMain : false;
if (shouldChangeMain) {
const { newMain } = await inquirer.createPromptModule()({
type: 'input',
name: 'newMain',
default: packageJSON.main,
message: 'Enter the relative path to your uncompiled main file',
});
packageJSON.main = newMain;
}

packageJSON.dependencies = packageJSON.dependencies || {};
packageJSON.devDependencies = packageJSON.devDependencies || {};

const keys = Object.keys(packageJSON.dependencies).concat(Object.keys(packageJSON.devDependencies));
const buildToolPackages = {
'electron-builder': 'provides mostly equivalent functionality',
'electron-download': 'already uses this module as a transitive dependency',
'electron-installer-debian': 'already uses this module as a transitive dependency',
'electron-installer-dmg': 'already uses this module as a transitive dependency',
'electron-installer-flatpak': 'already uses this module as a transitive dependency',
'electron-installer-redhat': 'already uses this module as a transitive dependency',
'electron-osx-sign': 'already uses this module as a transitive dependency',
'electron-packager': 'already uses this module as a transitive dependency',
'electron-winstaller': 'already uses this module as a transitive dependency',
};

let electronName;
for (const key of keys) {
if (key === 'electron' || key === 'electron-prebuilt') {
delete packageJSON.dependencies[key];
delete packageJSON.devDependencies[key];
electronName = key;
} else if (buildToolPackages[key]) {
const explanation = buildToolPackages[key];
const shouldRemoveDependency = !interactive || (await inquirer.createPromptModule()({
type: 'confirm',
name: 'shouldRemoveDependency',
message: `Do you want us to remove the "${key}" dependency in package.json? Electron Forge ${explanation}.`,
})).shouldRemoveDependency;

if (shouldRemoveDependency) {
delete packageJSON.dependencies[key];
delete packageJSON.devDependencies[key];
}
}
}

const writeChanges = async () => {
await asyncOra('Writing modified package.json file', async () => {
await fs.writeFile(path.resolve(dir, 'package.json'), `${JSON.stringify(packageJSON, null, 2)}\n`);
});
};

let electronVersion;
if (electronName) {
const electronPackageJSON = await readPackageJSON(path.resolve(dir, 'node_modules', electronName));
electronVersion = electronPackageJSON.version;
packageJSON.devDependencies['electron-prebuilt-compile'] = electronVersion;
}

await writeChanges();

if (electronName) {
await asyncOra('Pruning deleted modules', async () => {
await new Promise((resolve) => {
d('attempting to prune node_modules in:', dir);
const child = yarnOrNPMSpawn(hasYarn() ? [] : ['prune'], {
cwd: dir,
stdio: 'ignore',
});
child.on('exit', () => resolve());
});
});

await asyncOra('Installing dependencies', async () => {
d('deleting old dependencies forcefully');
await fs.remove(path.resolve(dir, 'node_modules/.bin/electron'));
await fs.remove(path.resolve(dir, 'node_modules/.bin/electron.cmd'));
await fs.remove(path.resolve(dir, 'node_modules', electronName));

d('installing dependencies');
await installDepList(dir, deps);
d('installing devDependencies');
await installDepList(dir, devDeps, true);
d('installing electron-prebuilt-compile');
await installDepList(dir, [`electron-prebuilt-compile@${electronVersion}`], false, true);
});
}

packageJSON = await readPackageJSON(dir);

packageJSON.config = packageJSON.config || {};
const templatePackageJSON = await readPackageJSON(path.resolve(__dirname, '../tmpl'));
packageJSON.config.forge = templatePackageJSON.config.forge;

await writeChanges();

await asyncOra('Fixing .gitignore', async () => {
if (await fs.exists(path.resolve(dir, '.gitignore'))) {
const gitignore = await fs.readFile(path.resolve(dir, '.gitignore'));
if (!gitignore.includes('out')) {
await fs.writeFile(path.resolve(dir, '.gitignore'), `${gitignore}\nout/`);
}
}
});

let babelConfig = packageJSON.babel;
const babelPath = path.resolve(dir, '.babelrc');
if (!babelConfig && await fs.exists(babelPath)) {
babelConfig = JSON.parse(await fs.readFile(babelPath, 'utf8'));
}

if (babelConfig) {
await asyncOra('Porting original babel config', async () => {
let compileConfig = {};
const compilePath = path.resolve(dir, '.compilerc');
if (await fs.exists(compilePath)) {
compileConfig = JSON.parse(await fs.readFile(compilePath, 'utf8'));
}

await fs.writeFile(compilePath, JSON.stringify(Object.assign(compileConfig, {
'application/javascript': babelConfig,
}), null, 2));
});

console.info('NOTE: You might be able to remove your `.compilerc` file completely if you are only using the `es2015` and `react` presets'.yellow);
}

console.info(`
We have ATTEMPTED to convert your app to be in a format that electron-forge understands.
Nothing much will have changed but we added the ${'"electron-prebuilt-compile"'.cyan} dependency. This is \
the dependency you must version bump to get newer versions of Electron.
We also tried to import any build tooling you already had but we can't get everything. You might need to convert any CLI/gulp/grunt tasks yourself.
Also please note if you are using \`preload\` scripts you need to follow the steps outlined \
at https://github.com/electron-userland/electron-forge/wiki/Using-%27preload%27-scripts
Thanks for using ${'"electron-forge"'.green}!!!`);
};
@@ -0,0 +1,21 @@
import 'colors';

import _import from './import';
import init from './init';
import install from './install';
import lint from './lint';
import make from './make';
import _package from './package';
import publish from './publish';
import start from './start';

module.exports = {
'import': _import, // eslint-disable-line
init,
install,
lint,
make,
'pacakge': _package, // eslint-disable-line
publish,
start,
};
@@ -0,0 +1,56 @@
import debug from 'debug';

import initCustom from '../init/init-custom';
import initDirectory from '../init/init-directory';
import initGit from '../init/init-git';
import initNPM from '../init/init-npm';
import initStandardFix from '../init/init-standard-fix';
import initStarter from '../init/init-starter-files';

const d = debug('electron-forge:init');

/**
* @typedef {Object} InitOptions
* @property {string} [dir=process.cwd()] The path to the module to import
* @property {boolean} [interactive=false] Boolean, whether to use sensible defaults or prompt the user visually.
* @property {string} [lintstyle=airbnb] The lintstyle to pass through to the template creater
* @property {string} [template] The custom template to use, if left empty will use the default template.
*/

/**
* Initializes a new electron-forge template project in the given directory
*
* @param {InitOptions} options - Options for the Import method
* @return {Promise} Will resolve when the initialization process is complete
*/
export default async (providedOptions = {}) => {
// eslint-disable-next-line prefer-const, no-unused-vars
let { dir, interactive, lintstyle, template } = Object.assign({
dir: process.cwd(),
interactive: false,
lintstyle: 'airbnb',
template: null,
}, providedOptions);

d(`Initializing in: ${dir}`);

if (!template) {
lintstyle = lintstyle.toLowerCase();
if (!['airbnb', 'standard'].includes(lintstyle)) {
d(`Unrecognized lintstyle argument: '${lintstyle}' -- defaulting to 'airbnb'`);
lintstyle = 'airbnb';
}
}

await initDirectory(dir);
await initGit(dir);
await initStarter(dir, template ? undefined : lintstyle);
await initNPM(dir, template ? undefined : lintstyle);
if (!template) {
if (lintstyle === 'standard') {
await initStandardFix(dir);
}
} else {
await initCustom(dir, template, lintstyle);
}
};

0 comments on commit 93fb48f

Please sign in to comment.
You can’t perform that action at this time.