@todesktop/cli 0.26.0 → 0.28.0-0

package/README.md

@@ -333,7 +333,15 @@ Default: Electron is downloaded from the main official source.
 
 Example: `https://cdn.npm.taobao.org/dist/electron/`
 
-The base URL of the mirror to download Electron from. This may be a mirror geographically closer to you or even your own mirror which contains custom Electron builds. The version downloaded is the Electron version specified in `devDependencies` in your app's `package.json`.
+The base URL of the mirror to download Electron from. This may be a mirror geographically closer to you or even your own mirror which contains custom Electron builds. The version downloaded is the Electron version specified in `devDependencies` in your app's `package.json`. Alternatively you can explicitly specify an `electronVersion` in `todesktop.json` as described below.
+
+### `electronVersion` - (optional) string
+
+Default: Electron version specified in `devDependencies` in your app's `package.json`
+
+Example: `12.0.7-beta.17`
+
+The version of Electron to use. In most cases you should not specify an `electronVersion` property. Only specify this option if you wish to override the version that is specified in `package.json`.
 
 ### `extraResources` - (optional) array of objects
 
@@ -645,3 +653,22 @@ The path to your application's Windows desktop icon. It must be an ICO, ICNS, or
 ### Recommendations for app package.json
 
 - You should set the `productName` property. Otherwise, your app name will default to the value of the `name` property.
+
+## FAQs
+
+### One of my dependencies is a private package. How do I safely using it with ToDesktop CLI
+
+ToDesktop CLI is similar to Continuous Integration service so you can use the guide from here: https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow/
+
+To summarize:
+
+1. Create a token using npm: `npm token create --read-only`.
+2. In ToDesktop's web UI go to Settings -> Build and Deploy.
+3. Enter an environment variable key of `NPM_TOKEN` and value should be the token entered above.
+4. Create an `.npmrc` file in the root of your project with the following contents:
+
+```
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
+```
+
+Note: **Do not put a token in this file**. You are specifying a literal value of `${NPM_TOKEN}`. NPM will replace the value for you. 5. Add `.npmrc` to your `appFiles` array `[".npmrc"]` in `todesktop.json`.

package/build/boot.js

@@ -0,0 +1,126 @@
+'use strict';
+const path = require('path');
+const camelcaseKeys = require('camelcase-keys');
+const decamelize = require('decamelize');
+const yargs = require('yargs');
+
+const getCommandsMessage = command => {
+	const usageString = [...command.usage, command.name].join(' ');
+	return `Commands:\n${command.subCommands.map(subCommand => `  ${usageString} ${subCommand.name}`).join('\n')}\n`;
+};
+
+module.exports = (dirname, React, Ink, originalCommands) => {
+	let commands = originalCommands;
+
+	// For backwards compatibility for builds made with versions prior to 1.1.0 that don't include positionalArgs
+	if (originalCommands.some(command => !command.positionalArgs && (command.args || []).some(arg => arg.positional))) {
+		commands = originalCommands.map(command => ({
+			...command,
+			positionalArgs: (command.args || []).filter(arg => arg.positional).map(arg => arg.key)
+		}));
+	}
+
+	const addCommand = (command, yargs) => {
+		// Don't need to add a description as it'll be handled by the * selector in the builder
+		// eslint-disable-next-line no-use-before-define
+		yargs.command(command.name, '', builder.bind(null, command), () => yargs.showHelp());
+	};
+
+	const handler = (command, argv) => {
+		const props = {
+			...camelcaseKeys(argv),
+			inputArgs: argv._
+		};
+
+		const UI = require(path.join(dirname, 'commands', command.path.replace('.tsx', '.js'))).default;
+		const {waitUntilExit} = Ink.render(React.createElement(UI, props));
+
+		waitUntilExit().catch(error => {
+			console.error(error.stack);
+		});
+	};
+
+	const builder = (command, yargs) => {
+		const {
+			positionalArgs = [],
+			args,
+			description,
+			name,
+			subCommands,
+			isDefaultIndex,
+			usage
+		} = command;
+
+		for (const subCommand of subCommands) {
+			addCommand({
+				...subCommand,
+				usage: [...usage, name]
+			}, yargs);
+		}
+
+		// If there is no index defined, yargs will just list the sub-commands
+		if (isDefaultIndex) {
+			return;
+		}
+
+		const hasPositionalArgs = positionalArgs.length > 0;
+		const positionalArgsString = positionalArgs.map(key => {
+			const {isRequired, type, aliases} = args.find(arg => arg.key === key);
+			const [startTag, endTag] = isRequired ? ['<', '>'] : ['[', type === 'array' ? '..]' : ']'];
+			const argsNames = [key, ...aliases.slice(0, 1)].map(name => decamelize(name, '-')).join('|');
+
+			return `${startTag}${argsNames}${endTag}`;
+		}).join(' ');
+
+		const yargsName = hasPositionalArgs ? `* ${positionalArgsString}` : '*';
+		const commandDescription = description || `${name} command`;
+
+		yargs.command(yargsName, commandDescription, scopedYargs => {
+			for (const arg of command.args) {
+				// `inputArgs` is a reserved prop by Pastel and doesn't require a definition in yargs
+				if (arg.key === 'inputArgs') {
+					continue;
+				}
+
+				if (arg.positional) {
+					scopedYargs.positional(decamelize(arg.key, '-'), {
+						type: arg.type,
+						description: arg.description,
+						default: arg.defaultValue,
+						// This only keeps one for some reason for positional arguments
+						// The slice ensures we keep the same as the one we add in the command
+						alias: arg.aliases.slice(0, 1).map(alias => decamelize(alias, '-'))
+					});
+				} else {
+					scopedYargs.option(decamelize(arg.key, '-'), {
+						type: arg.type,
+						description: arg.description,
+						default: arg.defaultValue,
+						demandOption: arg.isRequired,
+						alias: arg.aliases.map(alias => decamelize(alias, '-'))
+					});
+				}
+			}
+
+			// If the index command takes no arguments and there are available sub-commands,
+			// list the sub-commands in the help message.
+			if (!hasPositionalArgs && subCommands.length > 0) {
+				const usageMessage = getCommandsMessage(command);
+				scopedYargs.demandCommand(0, 0, usageMessage, usageMessage);
+			}
+		}, handler.bind(null, command));
+	};
+
+	yargs.command(
+		'*', '',
+		yargs => {
+			const usage = [path.basename(yargs.$0)];
+			for (const command of commands) {
+				addCommand({...command, usage}, yargs);
+			}
+		},
+		() => yargs.showHelp()
+	);
+
+	yargs.parse();
+};

package/build/cli.js

@@ -2,7 +2,7 @@
 'use strict';
 const React = require('react'); // eslint-disable-line import/no-unresolved
 const Ink = require('ink'); // eslint-disable-line import/no-unresolved
-const boot = require('pastel/boot'); // eslint-disable-line import/no-extraneous-dependencies, import/no-unresolved
+const boot = require('./boot'); // eslint-disable-line import/no-extraneous-dependencies, import/no-unresolved
 const {commands} = require('./commands.json'); // eslint-disable-line import/no-unresolved
 
 // This file is an entrypoint of CLI applications based on Pastel

package/build/cli.js.bak

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+'use strict';
+const React = require('react'); // eslint-disable-line import/no-unresolved
+const Ink = require('ink'); // eslint-disable-line import/no-unresolved
+const boot = require('pastel/boot'); // eslint-disable-line import/no-extraneous-dependencies, import/no-unresolved
+const {commands} = require('./commands.json'); // eslint-disable-line import/no-unresolved
+
+// This file is an entrypoint of CLI applications based on Pastel
+// This file is copied to "build" directory of the CLI and "bin" field
+// in package.json must point to it
+boot(__dirname, React, Ink, commands);