Merge pull request #701 from izaera/IFI-2730

refactor: move common platform code projects to JS Toolkit

Author: izaera

projects/js-toolkit/package.json

@@ -12,7 +12,7 @@
 		"preversion": "echo Cannot version private package; false",
 		"qa": "node scripts/qa/index.js",
 		"test": "liferay-workspace-scripts test",
-		"watch": "node scripts/watch.js"
+		"watch": "node scripts/watch.js --all"
 	},
 	"version": "0.1.0"
 }

projects/js-toolkit/packages/dev-server/package.json

@@ -21,8 +21,9 @@
 		"url": "https://github.com/liferay/liferay-frontend-projects.git"
 	},
 	"scripts": {
-		"build": "tsc",
+		"build": "node ../../scripts/build.js",
 		"ci": "liferay-workspace-scripts ci",
+		"clean": "node ../../scripts/clean.js",
 		"format": "liferay-workspace-scripts format",
 		"format:check": "liferay-workspace-scripts format:check",
 		"lint": "liferay-workspace-scripts lint",

projects/js-toolkit/packages/dev-server/tsconfig.json

@@ -1,6 +1,7 @@
 {
 	"extends": "../../tsconfig.json",
 	"compilerOptions": {
+		"lib": ["ES2015", "DOM"],
 		"outDir": "./lib",
 		"rootDir": "./src"
 	},

target-platforms/packages/portal-adapt-base/.yarnrc renamed to projects/js-toolkit/packages/portal-adapt-base/.yarnrc

@@ -0,0 +1,32 @@
+{
+	"author": "Liferay Frontend Infrastructure Team <pt-frontend-infrastructure@liferay.com>",
+	"dependencies": {
+		"@liferay/portal-base": "^1.0.0",
+		"cross-spawn": "^7.0.0",
+		"escape-string-regexp": "^2.0.0",
+		"globby": "^10.0.1"
+	},
+	"description": "Base library for adaptation autopresets",
+	"license": "LGPL-3.0",
+	"main": "lib/index.js",
+	"name": "@liferay/portal-adapt-base",
+	"repository": {
+		"directory": "projects/js-toolkit/packages/portal-adapt-base",
+		"type": "git",
+		"url": "https://github.com/liferay/liferay-frontend-projects.git"
+	},
+	"scripts": {
+		"build": "node ../../scripts/build.js",
+		"ci": "liferay-workspace-scripts ci",
+		"clean": "node ../../scripts/clean.js",
+		"format": "liferay-workspace-scripts format",
+		"format:check": "liferay-workspace-scripts format:check",
+		"lint": "liferay-workspace-scripts lint",
+		"lint:fix": "liferay-workspace-scripts lint:fix",
+		"postversion": "liferay-workspace-scripts publish",
+		"prepublishOnly": "yarn build",
+		"preversion": "liferay-workspace-scripts ci",
+		"test": "liferay-workspace-scripts test"
+	},
+	"version": "1.0.0"
+}

projects/js-toolkit/packages/portal-adapt-base/package.json

@@ -3,45 +3,37 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-const {
-	FilePath,
-	TemplateRenderer,
-	format,
-} = require('@liferay/js-toolkit-core');
-const project = require('liferay-npm-build-tools-common/lib/project');
+import {FilePath, TemplateRenderer, format} from '@liferay/js-toolkit-core';
+import * as project from 'liferay-npm-build-tools-common/lib/project';
 
-const runNodeModulesBin = require('./util/runNodeModulesBin');
-const runPkgJsonScript = require('./util/runPkgJsonScript');
+import runNodeModulesBin from './util/runNodeModulesBin';
+import runPkgJsonScript from './util/runPkgJsonScript';
 
 const {fail, info, print} = format;
-const {ProjectType} = project;
+const {ANGULAR_CLI, CREATE_REACT_APP, VUE_CLI} = project.ProjectType;
 
 const templatesDir = new FilePath(__dirname).join('templates');
 
-module.exports = function build() {
+export default async function build(): Promise<void> {
 	switch (project.default.probe.type) {
-		case ProjectType.ANGULAR_CLI:
-			buildWith('build');
+		case ANGULAR_CLI:
+			await buildWith('build');
 			break;
 
-		case ProjectType.CREATE_REACT_APP:
-			buildWith('build');
+		case CREATE_REACT_APP:
+			await buildWith('build');
 			break;
 
-		case ProjectType.VUE_CLI:
-			buildWith('build', ['--prod=true']);
+		case VUE_CLI:
+			await buildWith('build', ['--prod=true']);
 			break;
 
 		default:
 			failWithUnsupportedProjectType();
 	}
-};
+}
 
-/**
- * @param {string} script
- * @param {Array<*>} args
- */
-async function buildWith(script, args = []) {
+async function buildWith(script: string, args: string[] = []): Promise<void> {
 	runPkgJsonScript(project.default, script, args);
 
 	const renderer = new TemplateRenderer(
@@ -59,7 +51,7 @@ async function buildWith(script, args = []) {
 	runNodeModulesBin(project.default, 'liferay-npm-bundler');
 }
 
-function failWithUnsupportedProjectType() {
+function failWithUnsupportedProjectType(): void {
 	print(
 		fail`
 Oops! Your project type is not supported by {Liferay JS Toolkit} or cannot be

target-platforms/packages/portal-adapt-base/src/build.js renamed to projects/js-toolkit/packages/portal-adapt-base/src/build.ts

@@ -0,0 +1,17 @@
+/**
+ * SPDX-FileCopyrightText: © 2021 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+import portalBase from '@liferay/portal-base';
+
+import build from './build';
+
+import type {Tasks} from '@liferay/portal-base';
+
+export default function (platformPath: string, taskOverrides: Tasks): void {
+	portalBase(platformPath, {
+		build,
+		...(taskOverrides || {}),
+	});
+}

projects/js-toolkit/packages/portal-adapt-base/src/index.ts

@@ -3,12 +3,34 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-const {FilePath} = require('@liferay/js-toolkit-core');
-const escapeStringRegexp = require('escape-string-regexp');
-const globby = require('globby');
-const project = require('liferay-npm-build-tools-common/lib/project');
+import {FilePath} from '@liferay/js-toolkit-core';
+import escapeStringRegexp from 'escape-string-regexp';
+import globby from 'globby';
+import {
+	BundlerLoaderContext,
+	BundlerLoaderReturn,
+} from 'liferay-npm-build-tools-common/lib/api/loaders';
+import * as project from 'liferay-npm-build-tools-common/lib/project';
 
-const replaceTokens = require('../util/replaceTokens');
+import replaceTokens from '../util/replaceTokens';
+
+/**
+ * Configuration options for `adapt-static-urls` loader
+ */
+export interface Options {
+
+	/** Project relative path of directory containing assets */
+	docroot: string;
+
+	/** List of regexps to match assets that need their URL to be processed */
+	include: string[] | string;
+
+	/** Prefix to add to file path (after 'o/${project.jar.webContextPath}/') */
+	prefix?: string;
+
+	/** Prepend a / to `o/${project.jar.webContextPath}/` */
+	prependSlash?: boolean;
+}
 
 /**
  * A loader to rewrite static asset URLs inside a file (usually a webpack
@@ -21,17 +43,12 @@ const replaceTokens = require('../util/replaceTokens');
  * [create-jar.features.web-context](https://github.com/liferay/liferay-frontend-projects/tree/master/maintenance/projects/js-toolkit/docs/.npmbundlerrc-file-reference.md#create-jarfeaturesweb-context).
  * inside `.npmbundlerrc`.
  *
- * @remarks
- * Valid options are:
- *
- *   - docroot: project relative path of directory containing assets
- *   - include: list of regexps to match assets that need their URL to be processed
- *   - prefix: prefix to add to file path (after 'o/${project.jar.webContextPath}/')
- *   - prependSlash: prepend a / to `o/${project.jar.webContextPath}/`
- *
  * @deprecated use `adapt-static-urls-at-runtime.ts` instead
  */
-module.exports = function adaptStaticURLs(context, options) {
+export default function adaptStaticURLs(
+	context: BundlerLoaderContext,
+	options: Options
+): BundlerLoaderReturn {
 	const {content, log} = context;
 	const {docroot, include, prefix = '', prependSlash = false} = replaceTokens(
 		project.default,
@@ -82,4 +99,4 @@ module.exports = function adaptStaticURLs(context, options) {
 	});
 
 	return modifiedContent;
-};
+}

target-platforms/packages/portal-adapt-base/src/loader/adaptStaticURLs.js renamed to projects/js-toolkit/packages/portal-adapt-base/src/loader/adaptStaticURLs.ts

@@ -3,12 +3,29 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-const {FilePath} = require('@liferay/js-toolkit-core');
-const escapeStringRegexp = require('escape-string-regexp');
-const globby = require('globby');
-const project = require('liferay-npm-build-tools-common/lib/project');
+import {FilePath} from '@liferay/js-toolkit-core';
+import escapeStringRegexp from 'escape-string-regexp';
+import globby from 'globby';
+import {
+	BundlerLoaderContext,
+	BundlerLoaderReturn,
+} from 'liferay-npm-build-tools-common/lib/api/loaders';
+import * as project from 'liferay-npm-build-tools-common/lib/project';
 
-const replaceTokens = require('../util/replaceTokens');
+import replaceTokens from '../util/replaceTokens';
+
+/** Configuration options for `adapt-static-urls` loader */
+export interface Options {
+
+	/** Project relative path of directory containing assets */
+	docroot: string;
+
+	/** List of regexps to match assets that need their URL to be processed */
+	include: string[] | string;
+
+	/** Whether to look for the whole URL inside the string or just a part */
+	matchSubstring: boolean;
+}
 
 /**
  * A loader to rewrite static asset URLs inside a file (usually a webpack
@@ -20,14 +37,11 @@ const replaceTokens = require('../util/replaceTokens');
  * The web context path is taken from property
  * [create-jar.features.web-context](https://github.com/liferay/liferay-frontend-projects/tree/master/maintenance/projects/js-toolkit/docs/.npmbundlerrc-file-reference.md#create-jarfeaturesweb-context).
  * inside `.npmbundlerrc`.
- *
- * Valid options are:
- *
- *   - docroot: project relative path of directory containing assets
- *   - include: list of regexps to match assets that need their URL to be processed
- *   - matchSubstring: whether to look for the whole URL inside the string or just a part
  */
-module.exports = function adaptStaticURLsAtRuntime(context, options) {
+export default function adaptStaticURLsAtRuntime(
+	context: BundlerLoaderContext,
+	options: Options
+): BundlerLoaderReturn {
 	const {content, log} = context;
 	const {docroot, include, matchSubstring = false} = replaceTokens(
 		project.default,
@@ -82,4 +96,4 @@ module.exports = function adaptStaticURLsAtRuntime(context, options) {
 	});
 
 	return modifiedContent;
-};
+}

target-platforms/packages/portal-adapt-base/src/loader/adaptStaticURLsAtRuntime.js renamed to projects/js-toolkit/packages/portal-adapt-base/src/loader/adaptStaticURLsAtRuntime.ts

@@ -3,9 +3,23 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-const project = require('liferay-npm-build-tools-common/lib/project');
+import {
+	BundlerLoaderContext,
+	BundlerLoaderReturn,
+} from 'liferay-npm-build-tools-common/lib/api/loaders';
+import * as project from 'liferay-npm-build-tools-common/lib/project';
 
-const replaceTokens = require('../util/replaceTokens');
+import replaceTokens from '../util/replaceTokens';
+
+/** Configuration options for `add-css-portlet-header` loader */
+export interface Options {
+
+	/**
+	 * Path to the CSS file to use as `header-portlet-css` property of the
+	 * portlet.
+	 */
+	css: string;
+}
 
 /**
  * A loader that adds the `com.liferay.portlet.header-portlet-css` to the
@@ -16,14 +30,11 @@ const replaceTokens = require('../util/replaceTokens');
  *
  * It is normally used from adapted projects to inject the framework's generated
  * CSS file into the portlet.
- *
- * @remarks
- *
- * Valid options are:
- *
- *   - css: path to the CSS file to use as `header-portlet-css` property of the portlet
  */
-module.exports = function addCSSPortletHeader(context, options) {
+export default function addCSSPortletHeader(
+	context: BundlerLoaderContext,
+	options: Options
+): BundlerLoaderReturn {
 	const {content, log} = context;
 	const {css} = replaceTokens(project.default, options);
 
@@ -44,4 +55,4 @@ module.exports = function addCSSPortletHeader(context, options) {
 	log.info('add-css-portlet-header', `Added ${css} as portlet CSS file`);
 
 	return JSON.stringify(pkgJson, null, '\t');
-};
+}