generator-liferay-theme/lib/util.js

Yeoman generator for creating Liferay themes

/**
 * SPDX-FileCopyrightText: © 2017 Liferay, Inc. <https://liferay.com>
 * SPDX-License-Identifier: MIT
 */

const gulp = require('gulp');
const {
	info,
	print,
	success,
	title,
} = require('liferay-npm-build-tools-common/lib/format');
const path = require('path');

const config = require('../lib/utils/config');
const pkgJson = require('../package.json');
const versions = require('./versions');

const FIRST_SUPPORTED_VERSION =
	versions.supported[versions.supported.length - 1];
const LAST_SUPPORTED_VERSION = versions.supported[0];

/**
 * Returns a normalized "kebab case" version of the supplied string, suitable
 * for use as a theme (or themelet, or layout) name.
 */
function normalizeName(name) {
	return splitWords(name.replace(/[^a-z0-9-]/gi, ''))
		.join('-')
		.toLowerCase();
}

/**
 * Run `gulp init` after successful creation of a project.
 *
 * @param {'plugin' | 'theme'} registerTasksModule
 */
function runGulpInit(registerTasksModule) {
	print(
		'\n',
		success`
		The project has been created successfully.
		`
	);

	print(
		info`
		Now we will invoke {gulp init} for you, to configure your deployment
		strategy. 
		
		Remember, that you can change your answers whenever you want by 
		running {gulp init} again.
		`
	);

	// We cannot load this before the project is created because it crashes
	// eslint-disable-next-line @liferay/no-dynamic-require
	const liferayThemeTasks = require(`liferay-theme-tasks/${registerTasksModule}`);

	liferayThemeTasks.registerTasks({gulp});

	if (config.batchMode()) {
		const project = require('liferay-theme-tasks/lib/project');

		project.store.deploymentStrategy = config.getDefaultAnswer(
			'init',
			'deploymentStrategy',
			'LocalAppServer'
		);
		project.store.appServerPath = config.getDefaultAnswer(
			'init',
			'appServerPath',
			path.join(path.dirname(project.dir), 'tomcat')
		);
		project.store.deployPath = config.getDefaultAnswer(
			'init',
			'deployPath',
			path.join(project.store.appServerPath.asNative, '..', 'deploy')
		);
		project.store.url = config.getDefaultAnswer(
			'init',
			'url',
			'http://localhost:8080'
		);

		if (project.store.deploymentStrategy === 'DockerContainer') {
			project.store.dockerContainerName = config.getDefaultAnswer(
				'init',
				'dockerContainerName',
				'liferay_portal_1'
			);
		}
	}
	else {
		gulp.series('init')();
	}
}

/**
 * Run `npm install` after successful creation of a project.
 */
function runInstall(generator) {
	const skipInstall = generator.options['skip-install'];

	if (!skipInstall) {
		generator.installDependencies({bower: false});
	}
}

/**
 * Show welcome message
 * @param {Generator} generator
 */
function sayHello(generator) {
	const generatorNamespace = generator.options.namespace;

	print(
		title`
		

		Welcome to the splendid Themes SDK generator!
		
		`,
		info`
		This version of the Themes SDK (${pkgJson.version}) supports Liferay DXP 
		and Portal CE from ${FIRST_SUPPORTED_VERSION} to ${LAST_SUPPORTED_VERSION}.

		For older versions, please use v8 of the toolkit:
	
			> npm install -g generator-liferay-theme@^8.0.0 ↩
			> yo ${generatorNamespace} ↩

		`,
		info`
		For detailed information regarding which version numbers of:

		  · {unstyled}, {styled}, {classic} and {admin} themes 
		  · {liferay-frontend-css-common} and {@clayui/css} npm packages
		  · {Bootstrap} framework

		are used by each release of Liferay DXP and Portal CE see the table at:

		https://github.com/liferay/clay/wiki/Liferay-Portal-@clayui-css-Versions

		`
	);
}

/**
 * Returns a "snake case" version of `name` (eg. "foo_bar_baz").
 */
function snakeCase(name) {
	return splitWords(name).join('_').toLowerCase();
}

/**
 * Splits `input` at word boundaries.
 *
 * eg. "foo bar" -> ["foo", "bar"]
 *     "foo-bar" -> ["foo", "bar"]
 *     "foo_bar" -> ["foo", "bar"]
 *     "FooBar" -> ["foo", "bar"]
 */
function splitWords(input) {
	return input.trim().split(/[ _-]|(?<=[a-z])(?=[A-Z])/);
}

module.exports = {
	normalizeName,
	runGulpInit,
	runInstall,
	sayHello,
	snakeCase,
};