✨ Render header strings

packages/nodes-base/gulpfile.js

@@ -1,11 +1,141 @@
-const { src, dest } = require('gulp');
+const { existsSync, promises: { writeFile } } = require('fs');
+const path = require('path');
+const { task, src, dest } = require('gulp');
+
+const ALLOWED_HEADER_KEYS = ['displayName', 'description'];
+const PURPLE_ANSI_COLOR_CODE = 35;
+
+task('build:icons', copyIcons);
 
 function copyIcons() {
-	src('nodes/**/*.{png,svg}')
-		.pipe(dest('dist/nodes'))
+	src('nodes/**/*.{png,svg}').pipe(dest('dist/nodes'))
 
-	return src('credentials/**/*.{png,svg}')
-		.pipe(dest('dist/credentials'));
+	return src('credentials/**/*.{png,svg}').pipe(dest('dist/credentials'));
 }
 
-exports.default = copyIcons;
+task('build:translations', writeHeadersAndTranslations);
+
+/**
+ * Write all node translation headers at `/dist/nodes/headers.js` and write
+ * each node translation at `/dist/nodes/<node>/translations/<language>.js`
+ */
+function writeHeadersAndTranslations(done) {
+	checkLocale();
+
+	const paths = getTranslationPaths();
+	const { headers, translations } = getHeadersAndTranslations(paths);
+
+	const headersDestinationPath = path.join(__dirname, 'dist', 'nodes', 'headers.js');
+
+	writeDestinationFile(headersDestinationPath, headers);
+
+	log('Headers translation file written to:');
+	log(headersDestinationPath, { bulletpoint: true });
+
+	translations.forEach(t => {
+		writeDestinationFile(t.destinationPath, t.content);
+	});
+
+	log('Main translation files written to:');
+	translations.forEach(t => log(t.destinationPath, { bulletpoint: true }))
+
+	done();
+}
+
+function getTranslationPaths() {
+	const destinationPaths = require('./package.json').n8n.nodes;
+	const { N8N_DEFAULT_LOCALE: locale } = process.env;
+	const seen = {};
+
+	return destinationPaths.reduce((acc, cur) => {
+		const sourcePath = path.join(
+			__dirname,
+			cur.split('/').slice(1, -1).join('/'),
+			'translations',
+			`${locale}.ts`,
+		);
+
+		if (existsSync(sourcePath) && !seen[sourcePath]) {
+			seen[sourcePath] = true;
+
+			const destinationPath = path.join(
+				__dirname,
+				cur.split('/').slice(0, -1).join('/'),
+				'translations',
+				`${locale}.js`,
+			);
+
+			acc.push({
+				source: sourcePath,
+				destination: destinationPath,
+			});
+		};
+
+		return acc;
+	}, []);
+}
+
+function getHeadersAndTranslations(paths) {
+	return paths.reduce((acc, cur) => {
+		const translation = require(cur.source);
+		const nodeType = Object.keys(translation).pop();
+		const { header } = translation[nodeType];
+
+		if (isValidHeader(header, ALLOWED_HEADER_KEYS)) {
+			acc.headers[nodeType] = header;
+		}
+
+		acc.translations.push({
+			destinationPath: cur.destination,
+			content: translation,
+		});
+
+		return acc;
+	}, { headers: {}, translations: [] });
+}
+
+
+// ----------------------------------
+//             helpers
+// ----------------------------------
+
+function isValidHeader(header, allowedHeaderKeys) {
+	if (!header) return false;
+
+	const headerKeys = Object.keys(header);
+
+	return headerKeys.length > 0 &&
+		headerKeys.every(key => allowedHeaderKeys.includes(key));
+}
+
+function checkLocale() {
+	const { N8N_DEFAULT_LOCALE: locale } = process.env;
+
+	log(`Default locale set to: ${colorize(PURPLE_ANSI_COLOR_CODE, locale || 'en')}`);
+
+	if (!locale || locale === 'en') {
+		log('No translation required - Skipping translations build...');
+		return;
+	};
+}
+
+function writeDestinationFile(destinationPath, data) {
+	writeFile(
+		destinationPath,
+		`module.exports = ${JSON.stringify(data, null, 2)}`,
+	);
+}
+
+const log = (string, { bulletpoint } = { bulletpoint: false }) => {
+	if (bulletpoint) {
+		process.stdout.write(
+			colorize(PURPLE_ANSI_COLOR_CODE, `- ${string}\n`),
+		);
+		return;
+	};
+
+	process.stdout.write(`${string}\n`);
+};
+
+const colorize = (ansiColorCode, string) =>
+	['\033[', ansiColorCode, 'm', string, '\033[0m'].join('')