first commit

packages/node-dev/commands/build.ts

@@ -0,0 +1,58 @@
+import { Container } from '@n8n/di';
+import { Command, Flags } from '@oclif/core';
+import { InstanceSettings } from 'n8n-core';
+
+import type { IBuildOptions } from '../src';
+import { buildFiles } from '../src';
+
+export class Build extends Command {
+	static description = 'Builds credentials and nodes and copies it to n8n custom extension folder';
+
+	static examples = [
+		'$ n8n-node-dev build',
+		'$ n8n-node-dev build --destination ~/n8n-nodes',
+		'$ n8n-node-dev build --watch',
+	];
+
+	static flags = {
+		help: Flags.help({ char: 'h' }),
+		destination: Flags.string({
+			char: 'd',
+			description: `The path to copy the compiled files to [default: ${
+				Container.get(InstanceSettings).customExtensionDir
+			}]`,
+		}),
+		watch: Flags.boolean({
+			description:
+				'Starts in watch mode and automatically builds and copies file whenever they change',
+		}),
+	};
+
+	async run() {
+		const { flags } = await this.parse(Build);
+
+		this.log('\nBuild credentials and nodes');
+		this.log('=========================');
+
+		try {
+			const options: IBuildOptions = {};
+
+			if (flags.destination) {
+				options.destinationFolder = flags.destination;
+			}
+			if (flags.watch) {
+				options.watch = true;
+			}
+
+			const outputDirectory = await buildFiles(options);
+
+			this.log(`The nodes got built and saved into the following folder:\n${outputDirectory}`);
+		} catch (error) {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+			this.log(`\nGOT ERROR: "${error.message}"`);
+			this.log('====================================');
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
+			this.log(error.stack);
+		}
+	}
+}

packages/node-dev/commands/new.ts

@@ -0,0 +1,156 @@
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import { Command } from '@oclif/core';
+import * as changeCase from 'change-case';
+import { access } from 'fs/promises';
+import * as inquirer from 'inquirer';
+import { join } from 'path';
+
+import { createTemplate } from '../src';
+
+export class New extends Command {
+	static description = 'Create new credentials/node';
+
+	static examples = ['$ n8n-node-dev new'];
+
+	async run() {
+		try {
+			this.log('\nCreate new credentials/node');
+			this.log('=========================');
+
+			// Ask for the type of not to be created
+			const typeQuestion: inquirer.QuestionCollection = {
+				name: 'type',
+				type: 'list',
+				default: 'Node',
+				message: 'What do you want to create?',
+				choices: ['Credentials', 'Node'],
+			};
+
+			const typeAnswers = await inquirer.prompt(typeQuestion);
+
+			let sourceFolder = '';
+			const sourceFileName = 'simple.ts';
+			let defaultName = '';
+			let getDescription = false;
+
+			if (typeAnswers.type === 'Node') {
+				// Create new node
+
+				getDescription = true;
+
+				const nodeTypeQuestion: inquirer.QuestionCollection = {
+					name: 'nodeType',
+					type: 'list',
+					default: 'Execute',
+					message: 'What kind of node do you want to create?',
+					choices: ['Execute', 'Trigger', 'Webhook'],
+				};
+
+				const nodeTypeAnswers = await inquirer.prompt(nodeTypeQuestion);
+
+				// Choose a the template-source-file depending on user input.
+				sourceFolder = 'execute';
+				defaultName = 'My Node';
+				if (nodeTypeAnswers.nodeType === 'Trigger') {
+					sourceFolder = 'trigger';
+					defaultName = 'My Trigger';
+				} else if (nodeTypeAnswers.nodeType === 'Webhook') {
+					sourceFolder = 'webhook';
+					defaultName = 'My Webhook';
+				}
+			} else {
+				// Create new credentials
+
+				sourceFolder = 'credentials';
+				defaultName = 'My Service API';
+			}
+
+			// Ask additional questions to know with what values the
+			// variables in the template file should be replaced with
+			const additionalQuestions = [
+				{
+					name: 'name',
+					type: 'input',
+					default: defaultName,
+					message: 'How should the node be called?',
+				},
+			];
+
+			if (getDescription) {
+				// Get also a node description
+				additionalQuestions.push({
+					name: 'description',
+					type: 'input',
+					default: 'Node converts input data to chocolate',
+					message: 'What should the node description be?',
+				});
+			}
+
+			const additionalAnswers = await inquirer.prompt(
+				additionalQuestions as inquirer.QuestionCollection,
+			);
+
+			const nodeName = additionalAnswers.name;
+
+			// Define the source file to be used and the location and name of the new
+			// node file
+			const destinationFilePath = join(
+				process.cwd(),
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+				`${changeCase.pascalCase(nodeName)}.${typeAnswers.type.toLowerCase()}.ts`,
+			);
+
+			const sourceFilePath = join(__dirname, '../../templates', sourceFolder, sourceFileName);
+
+			// Check if node with the same name already exists in target folder
+			// to not overwrite it by accident
+			try {
+				await access(destinationFilePath);
+
+				// File does already exist. So ask if it should be overwritten.
+				const overwriteQuestion: inquirer.QuestionCollection = [
+					{
+						name: 'overwrite',
+						type: 'confirm',
+						default: false,
+						message: `The file "${destinationFilePath}" already exists and would be overwritten. Do you want to proceed and overwrite the file?`,
+					},
+				];
+
+				const overwriteAnswers = await inquirer.prompt(overwriteQuestion);
+
+				if (overwriteAnswers.overwrite === false) {
+					this.log('\nNode creation got canceled!');
+					return;
+				}
+			} catch (error) {
+				// File does not exist. That is exactly what we want so go on.
+			}
+
+			// Make sure that the variables in the template file get formatted
+			// in the correct way
+			const replaceValues = {
+				ClassNameReplace: changeCase.pascalCase(nodeName),
+				DisplayNameReplace: changeCase.capitalCase(nodeName),
+				N8nNameReplace: changeCase.camelCase(nodeName),
+				NodeDescriptionReplace: additionalAnswers.description,
+			};
+
+			await createTemplate(sourceFilePath, destinationFilePath, replaceValues);
+
+			this.log('\nExecution was successful:');
+			this.log('====================================');
+
+			this.log(`Node got created: ${destinationFilePath}`);
+		} catch (error) {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+			this.log(`\nGOT ERROR: "${error.message}"`);
+			this.log('====================================');
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+			this.log(error.stack);
+		}
+	}
+}