fix: plugin create command needs more args for plugin seed

There are two new prompts in the plugin seed which require new command line options to be passed from CLI. Handle the new prompts and pass the new options. They can be used in automation scripts.
In order to prevent such issue in the future, ensure the spawned process's stdout and stdin are inherited, so if there's a prompt in the plugin seed, CLI will show it to the user.

Author: rosen-vladimirov

docs/man_pages/lib-management/plugin-create.md

@@ -28,6 +28,8 @@ Create from a custom plugin seed | `$ tns plugin create <Plugin Repository Name>
 * `--path` - Specifies the directory where you want to create the project, if different from the current directory.
 * `--username` - Specifies the Github username, which will be used to build the URLs in the plugin's package.json file.
 * `--pluginName` - Used to set the default file and class names in the plugin source.
+* `--includeTypeScriptDemo` - Specifies if TypeScript demo should be created. Default value is `y` (i.e. `demo` will be created), in case you do not want to create this demo, pass `--includeTypeScriptDemo=n`
+* `--includeAngularDemo` - Specifies if Angular demo should be created. Default value is `y` (i.e. `demo-angular` will be created), in case you do not want to create this demo, pass `--includeAngularDemo=n`
 * `--template` - Specifies the custom seed archive, which you want to use to create your plugin. If `--template` is not set, the NativeScript CLI creates the plugin from the default NativeScript Plugin Seed. `<Template>` can be a URL or a local path to a `.tar.gz` file with the contents of a seed repository.<% if(isHtml) { %> This must be a clone of the [NativeScript Plugin Seed](https://github.com/NativeScript/nativescript-plugin-seed) and must contain a `src` directory with a package.json file and a script at `src/scripts/postclone.js`. After the archive is extracted, the postclone script will be executed with the username (`gitHubUsername`) and plugin name (`pluginName`) parameters given to the `tns plugin create` command prompts. For more information, visit the default plugin seed repository and [examine the source script](https://github.com/NativeScript/nativescript-plugin-seed/blob/master/src/scripts/postclone.js) there. Examples:
 
   * Using a local file:

lib/commands/plugin/create-plugin.ts

@@ -5,6 +5,8 @@ export class CreatePluginCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 	public userMessage = "What is your GitHub username?\n(will be used to update the Github URLs in the plugin's package.json)";
 	public nameMessage = "What will be the name of your plugin?\n(use lowercase characters and dashes only)";
+	public includeTypeScriptDemoMessage = 'Do you want to include a "TypeScript NativeScript" application linked with your plugin to make development easier?';
+	public includeAngularDemoMessage = 'Do you want to include an "Angular NativeScript" application linked with your plugin to make development easier?';
 	public pathAlreadyExistsMessageTemplate = "Path already exists and is not empty %s";
 	constructor(private $options: IOptions,
 		private $errors: IErrors,
@@ -62,15 +64,25 @@ export class CreatePluginCommand implements ICommand {
 
 		const gitHubUsername = await this.getGitHubUsername(config.username);
 		const pluginNameSource = await this.getPluginNameSource(config.pluginName, pluginRepoName);
+		const includeTypescriptDemo = await this.getShouldIncludeDemoResult(config.includeTypeScriptDemo, this.includeTypeScriptDemoMessage);
+		const includeAngularDemo = await this.getShouldIncludeDemoResult(config.includeAngularDemo, this.includeAngularDemoMessage);
 
-		if (!isInteractive() && (!config.username || !config.pluginName)) {
-			this.$logger.printMarkdown("Using default values for Github user and/or plugin name since your shell is not interactive.");
+		if (!isInteractive() && (!config.username || !config.pluginName || !config.includeAngularDemo || !config.includeTypeScriptDemo)) {
+			this.$logger.printMarkdown("Using default values for plugin creation options since your shell is not interactive.");
 		}
 
 		// run postclone script manually and kill it if it takes more than 10 sec
 		const pathToPostCloneScript = path.join("scripts", "postclone");
-		const params = [pathToPostCloneScript, `gitHubUsername=${gitHubUsername}`, `pluginName=${pluginNameSource}`, "initGit=y"];
-		const outputScript = (await this.$childProcess.spawnFromEvent(process.execPath, params, "close", { cwd, timeout: 10000 }));
+		const params = [
+			pathToPostCloneScript,
+			`gitHubUsername=${gitHubUsername}`,
+			`pluginName=${pluginNameSource}`,
+			"initGit=y",
+			`includeTypeScriptDemo=${includeTypescriptDemo}`,
+			`includeAngularDemo=${includeAngularDemo}`
+		];
+
+		const outputScript = (await this.$childProcess.spawnFromEvent(process.execPath, params, "close", { stdio: "inherit", cwd, timeout: 10000 }));
 		if (outputScript && outputScript.stdout) {
 			this.$logger.printMarkdown(outputScript.stdout);
 		}
@@ -101,7 +113,7 @@ export class CreatePluginCommand implements ICommand {
 		}
 	}
 
-	private async getGitHubUsername(gitHubUsername: string) {
+	private async getGitHubUsername(gitHubUsername: string): Promise<string> {
 		if (!gitHubUsername) {
 			gitHubUsername = "NativeScriptDeveloper";
 			if (isInteractive()) {
@@ -112,7 +124,7 @@ export class CreatePluginCommand implements ICommand {
 		return gitHubUsername;
 	}
 
-	private async getPluginNameSource(pluginNameSource: string, pluginRepoName: string) {
+	private async getPluginNameSource(pluginNameSource: string, pluginRepoName: string): Promise<string> {
 		if (!pluginNameSource) {
 			// remove nativescript- prefix for naming plugin files
 			const prefix = 'nativescript-';
@@ -124,6 +136,15 @@ export class CreatePluginCommand implements ICommand {
 
 		return pluginNameSource;
 	}
+
+	private async getShouldIncludeDemoResult(includeDemoOption: string, message: string): Promise<string> {
+		let shouldIncludeDemo = !!includeDemoOption;
+		if (!includeDemoOption && isInteractive()) {
+			shouldIncludeDemo = await this.$prompter.confirm(message, () => { return true; });
+		}
+
+		return shouldIncludeDemo ? "y" : "n";
+	}
 }
 
 $injector.registerCommand(["plugin|create"], CreatePluginCommand);

lib/declarations.d.ts

@@ -493,6 +493,8 @@ interface IPort {
 interface IPluginSeedOptions {
 	username: string;
 	pluginName: string;
+	includeTypeScriptDemo: string;
+	includeAngularDemo: string;
 }
 
 interface IAndroidBundleOptions {

lib/options.ts

@@ -120,6 +120,8 @@ export class Options {
 			background: { type: OptionType.String, hasSensitiveValue: false },
 			username: { type: OptionType.String, hasSensitiveValue: true },
 			pluginName: { type: OptionType.String, hasSensitiveValue: false },
+			includeTypeScriptDemo: { type: OptionType.String, hasSensitiveValue: false },
+			includeAngularDemo: { type: OptionType.String, hasSensitiveValue: false },
 			hmr: { type: OptionType.Boolean, hasSensitiveValue: false },
 			collection: { type: OptionType.String, alias: "c", hasSensitiveValue: false },
 			json: { type: OptionType.Boolean, hasSensitiveValue: false },

test/plugin-create.ts

@@ -19,6 +19,8 @@ const dummyProjectName = "dummyProjectName";
 const dummyArgs = [dummyProjectName];
 const dummyUser = "devUsername";
 const dummyName = "devPlugin";
+const createDemoProjectAnswer = true;
+const creteDemoProjectOption = "y";
 const dummyPacote: IPacoteOutput = { packageName: "", destinationDirectory: "" };
 
 function createTestInjector() {
@@ -104,48 +106,99 @@ describe("Plugin create command tests", () => {
 			await createPluginCommand.execute(dummyArgs);
 		});
 
-		it("should pass when only project name is set with prompts in interactive shell.", async () => {
+		it("should pass when all options are set with prompts in interactive shell.", async () => {
 			const prompter = testInjector.resolve("$prompter");
 			const strings: IDictionary<string> = {};
+			const confirmQuestions: IDictionary<boolean> = {};
 			strings[createPluginCommand.userMessage] = dummyUser;
 			strings[createPluginCommand.nameMessage] = dummyName;
+			confirmQuestions[createPluginCommand.includeTypeScriptDemoMessage] = createDemoProjectAnswer;
+			confirmQuestions[createPluginCommand.includeAngularDemoMessage] = createDemoProjectAnswer;
 
 			prompter.expect({
-				strings: strings
+				strings: strings,
+				confirmQuestions
 			});
 			await createPluginCommand.execute(dummyArgs);
 			prompter.assert();
 		});
 
-		it("should pass with project name and username set with one prompt in interactive shell.", async () => {
+		it("should pass when username is passed with command line option and all other options are populated with prompts in interactive shell.", async () => {
 			options.username = dummyUser;
 			const prompter = testInjector.resolve("$prompter");
 			const strings: IDictionary<string> = {};
+			const confirmQuestions: IDictionary<boolean> = {};
 			strings[createPluginCommand.nameMessage] = dummyName;
+			confirmQuestions[createPluginCommand.includeTypeScriptDemoMessage] = createDemoProjectAnswer;
+			confirmQuestions[createPluginCommand.includeAngularDemoMessage] = createDemoProjectAnswer;
 
 			prompter.expect({
-				strings: strings
+				strings: strings,
+				confirmQuestions
 			});
 			await createPluginCommand.execute(dummyArgs);
 			prompter.assert();
 		});
 
-		it("should pass with project name and pluginName set with one prompt in interactive shell.", async () => {
+		it("should pass when plugin name is passed with command line option and all other options are populated with prompts in interactive shell.", async () => {
 			options.pluginName = dummyName;
 			const prompter = testInjector.resolve("$prompter");
 			const strings: IDictionary<string> = {};
+			const confirmQuestions: IDictionary<boolean> = {};
+
 			strings[createPluginCommand.userMessage] = dummyUser;
+			confirmQuestions[createPluginCommand.includeTypeScriptDemoMessage] = createDemoProjectAnswer;
+			confirmQuestions[createPluginCommand.includeAngularDemoMessage] = createDemoProjectAnswer;
 
 			prompter.expect({
-				strings: strings
+				strings,
+				confirmQuestions
 			});
 			await createPluginCommand.execute(dummyArgs);
 			prompter.assert();
 		});
 
-		it("should pass with project name, username and pluginName set with no prompt in interactive shell.", async () => {
+		it("should pass when includeTypeScriptDemo is passed with command line option and all other options are populated with prompts in interactive shell.", async () => {
+			options.includeTypeScriptDemo = creteDemoProjectOption;
+			const prompter = testInjector.resolve("$prompter");
+			const strings: IDictionary<string> = {};
+			const confirmQuestions: IDictionary<boolean> = {};
+			strings[createPluginCommand.userMessage] = dummyUser;
+			strings[createPluginCommand.nameMessage] = dummyName;
+			confirmQuestions[createPluginCommand.includeAngularDemoMessage] = createDemoProjectAnswer;
+
+			prompter.expect({
+				strings: strings,
+				confirmQuestions
+			});
+			await createPluginCommand.execute(dummyArgs);
+			prompter.assert();
+		});
+
+		it("should pass when includeAngularDemo is passed with command line option and all other options are populated with prompts in interactive shell.", async () => {
+			options.includeAngularDemo = creteDemoProjectOption;
+			const prompter = testInjector.resolve("$prompter");
+			const strings: IDictionary<string> = {};
+			const confirmQuestions: IDictionary<boolean> = {};
+
+			strings[createPluginCommand.userMessage] = dummyUser;
+			strings[createPluginCommand.nameMessage] = dummyName;
+			confirmQuestions[createPluginCommand.includeTypeScriptDemoMessage] = createDemoProjectAnswer;
+
+			prompter.expect({
+				strings: strings,
+				confirmQuestions
+			});
+			await createPluginCommand.execute(dummyArgs);
+			prompter.assert();
+		});
+
+		it("should pass with all options passed through command line opts with no prompt in interactive shell.", async () => {
 			options.username = dummyUser;
 			options.pluginName = dummyName;
+			options.includeTypeScriptDemo = creteDemoProjectOption;
+			options.includeAngularDemo = creteDemoProjectOption;
+
 			await createPluginCommand.execute(dummyArgs);
 		});
 

test/stubs.ts

@@ -571,13 +571,15 @@ export class PrompterStub implements IPrompter {
 	private passwords: IDictionary<string> = {};
 	private answers: IDictionary<string> = {};
 	private questionChoices: IDictionary<any[]> = {};
+	private confirmQuestions: IDictionary<boolean> = {};
 
-	expect(options?: { strings?: IDictionary<string>, passwords?: IDictionary<string>, answers?: IDictionary<string>, questionChoices?: IDictionary<any[]> }) {
+	expect(options?: { strings?: IDictionary<string>, passwords?: IDictionary<string>, answers?: IDictionary<string>, questionChoices?: IDictionary<any[]>, confirmQuestions?: IDictionary<boolean> }) {
 		if (options) {
 			this.strings = options.strings || this.strings;
 			this.passwords = options.passwords || this.passwords;
 			this.answers = options.answers || this.answers;
 			this.questionChoices = options.questionChoices || this.questionChoices;
+			this.confirmQuestions = options.confirmQuestions || this.confirmQuestions;
 		}
 	}
 
@@ -607,7 +609,10 @@ export class PrompterStub implements IPrompter {
 		return result;
 	}
 	async confirm(message: string, defaultAction?: () => boolean): Promise<boolean> {
-		throw unreachable();
+		chai.assert.ok(message in this.confirmQuestions, `PrompterStub didn't expect to be asked for: ${message}`);
+		const result = this.confirmQuestions[message];
+		delete this.confirmQuestions[message];
+		return result;
 	}
 	dispose(): void {
 		throw unreachable();
@@ -620,6 +625,9 @@ export class PrompterStub implements IPrompter {
 		for (const key in this.passwords) {
 			throw unexpected(`PrompterStub was instructed to reply with "${this.passwords[key]}" to a "${key}" password request, but was never asked!`);
 		}
+		for (const key in this.confirmQuestions) {
+			throw unexpected(`PrompterStub was instructed to reply with "${this.confirmQuestions[key]}" to a "${key}" confirm question, but was never asked!`);
+		}
 	}
 }