lucy-cli 2.0.0-alpha.9 → 2.0.0-beta.1

package/src/tasks/Gulpfile.ts

@@ -0,0 +1,207 @@
+import gulp from 'gulp';
+import gulpSass from 'gulp-sass';
+import shell from 'gulp-shell';
+import * as os from 'os';
+import * as dartSass from 'sass';
+import { join } from "path";
+
+import backendSettings from '../../settings/backend-settings.json' with { type: "json" };;
+import masterSettings from '../../settings/master-settings.json' with { type: "json" };;
+import pageSettings from '../../settings/page-settings.json' with { type: "json" };;
+import publicSettings from '../../settings/public-settings.json' with { type: "json" };;
+
+import { buildPublic } from './gulp/public.js';
+import { buildBackend, buildBackendJSW } from './gulp/backend.js';
+import { checkPages, checkTs } from './gulp/checks.js';
+import { compileScss } from './gulp/styles.js';
+import { buildPages } from './gulp/pages.js';
+import { previewTemplates } from './gulp/templates.js';
+import { copyFiles } from './gulp/copy.js';
+import { cleanSrc, cleanWix } from './gulp/clean.js';
+import { addTypes, updateWixTypes } from './gulp/types.js';
+import { setProdConfig } from './gulp/pipeline.js';
+import { watchAll } from './gulp/watchers.js';
+import { getModulesSourcePaths } from './gulp/helpers.js';
+import { logger } from '../utils/logger.js';
+import { Effect } from 'effect/index';
+import { Config } from '../config.js';
+import { AppError } from '../error.js';
+import { TaskOptions } from '../schemas/gulp.js';
+
+const sass = gulpSass(dartSass);
+
+export const task_runGulp = Effect.gen(function* (_) {
+	const config = (yield* Config).config;
+	const task = config.action.tasksName || "dev";	
+
+	const taskOptions: TaskOptions = { 
+		enableIncrementalBuild: config.action.tasksName === 'dev' ? true : false, 
+		outputDir: './src', 
+		sass, 
+		pageSettings, 
+		publicSettings, 
+		backendSettings, 
+		masterSettings, 
+		replaceOptions: {
+			logs: {
+				enabled: false
+			}
+		},
+		cwd: process.cwd(),
+		modulesSourcePaths: yield* getModulesSourcePaths,
+	};
+
+	
+	logger.action(`Running task: ${task}`);
+
+	gulp.task('check-ts', gulp.parallel( 
+		checkTs(taskOptions),
+	));
+
+	gulp.task('scss', gulp.parallel( 
+		compileScss(taskOptions),
+	));
+
+	gulp.task('build-backend', gulp.parallel( 
+		buildBackend(taskOptions),
+		buildBackendJSW(taskOptions),
+		// buildBackendHTTP(taskOptions),
+	));
+
+	gulp.task('build-public', gulp.parallel( 
+		buildPublic(taskOptions),
+	));
+
+	gulp.task('preview-templates', gulp.parallel(
+		previewTemplates(taskOptions),
+	));
+
+	gulp.task('copy-files', gulp.parallel(
+		copyFiles(taskOptions),
+	));
+
+	gulp.task('test', function () {
+		return shell.task(
+			['yarn test'],
+			{ ignoreErrors: true }
+		)().then(() => {
+			logger.success("Tests completed successfully.");
+		}).catch(err => {
+			logger.error("Error in test task!");
+		});
+	});
+	gulp.task('test-ci', function () {
+		return shell.task(
+			['yarn test --run'],
+			{ ignoreErrors: true }
+		)().then(() => {
+			logger.success("Tests completed successfully.");
+		}).catch(err => {
+			logger.error("Error in test task!");
+		});
+	});
+
+	gulp.task('sync-types', shell.task([
+		'yarn postinstall',
+	]));
+
+	gulp.task('fix-wix-types', gulp.parallel(
+		updateWixTypes(taskOptions)
+	));
+
+	gulp.task('add-wix-types', function(done: gulp.TaskFunctionCallback) {
+		return addTypes(taskOptions, done);
+	});
+
+	gulp.task('set-production', gulp.parallel(
+		setProdConfig()
+	));
+
+	gulp.task('start-wix', shell.task([
+		'yarn wix:dev',
+	]));
+
+	gulp.task('gen-docs', shell.task([
+		'yarn docs',
+	]));
+
+	gulp.task('fix-wix', gulp.series(
+		cleanWix(),
+		'sync-types', 
+		'fix-wix-types', 
+		'add-wix-types'
+	));
+
+	gulp.task('build', gulp.parallel(
+		'build-backend', 
+		'build-public', 
+		'preview-templates',
+		buildPages(taskOptions),
+		compileScss(taskOptions), 
+		'copy-files'
+		)
+	);
+
+	gulp.task('build-pipeline', gulp.series(
+		cleanSrc(taskOptions),
+		'set-production',
+		'check-ts',
+		'fix-wix-types', 
+		'add-wix-types',
+		'test-ci',
+		'build',
+	));
+
+	gulp.task('build-prod', gulp.series(
+		(done) => checkPages(true, false).then(() => done(), (err) => done(err)),
+		cleanSrc(taskOptions),
+		'set-production', 
+		'fix-wix', 
+		'check-ts',
+		'test-ci',
+		'build-backend', 
+		'build-public', 
+		buildPages(taskOptions),
+		'copy-files',
+		compileScss(taskOptions),
+		// 'gen-docs'
+	));
+
+	gulp.task('start-dev-env', gulp.parallel(
+		watchAll(taskOptions),
+		'test',
+		'start-wix',
+		'check-ts',
+		(done) => checkPages(false, config.force).then(() => done(), (err) => done(err)),
+	));
+
+	gulp.task('dev', gulp.series(
+		cleanSrc(taskOptions),
+		'fix-wix',
+		'build',
+		'start-dev-env', 
+		)
+	);
+
+	yield* Effect.tryPromise({
+		try: () =>  {
+			return new Promise(function (resolve, reject) {
+				gulp.series(task, (done) => {
+					resolve(true);
+					done();
+				})(function (err) {
+					if (err) {
+						logger.error("Error starting tasks:", err);
+						reject(err);
+					}
+				});
+			});
+		},
+		catch: (e) => {
+			logger.error("Error starting tasks:", e);
+			return new AppError({ message: 'Error starting tasks', cause: e });
+		}
+	})
+
+	logger.report("Task completed successfully:", task);
+});

package/src/tasks/gulp/backend.ts

@@ -0,0 +1,113 @@
+import gulp from 'gulp';
+import rename from 'gulp-rename';
+import * as path from 'path';
+import swc from 'gulp-swc';
+import { logger } from '../../utils/logger.js';
+import { TaskOptions } from '../../schemas/gulp.js';
+import { TaskType } from '../../schemas/types.js';
+
+const swcOptions = {
+    jsc: {
+        target: 'es2020',
+        parser: {
+            syntax: "typescript",
+            tsx: true,
+            decorators: true,
+            // preserveAllComments: true
+        },
+        preserveAllComments: false,
+        minify: {
+            compress: true // equivalent to {}
+        }
+    },
+};
+
+export function buildBackend(options: TaskOptions): TaskType {
+    const folders = ['typescript', ...options.modulesSourcePaths];
+
+    const { outputDir } = options;
+
+    // Create tasks for each folder
+    const tasks = folders.map((folder) => {
+        const taskName = `build_Backend-${folder}`; // Create a unique name for each task
+
+        const task = () =>
+            gulp.src([
+                `${folder}/backend/**/*.ts`,
+                `${folder}/backend/**/*.tsx`,
+                `!${folder}/backend/**/*.jsw.ts`,
+                `!${folder}/backend/**/*.spec.ts`,
+            ])
+                .pipe(swc(swcOptions))
+                .on('error', function (e: Error) {
+                    logger.error(`Build of Backend files for ${folder} failed!`);
+                    logger.error(`Error: ${e.message}`);
+
+                    this.emit('end');
+                })
+                .pipe(gulp.dest(path.join(outputDir, 'backend')))
+                .on('error', function (e: Error) {
+                    logger.error(`Build of Backend files for ${folder} failed!`);
+                    logger.error(`Error: ${e.message}`);
+
+                    this.emit('end');
+                })
+                .on('end', function () {
+                    logger.success(`Build of Backend files for ${folder} succeeded!`);
+                });
+
+        // Register the task with Gulp
+        Object.defineProperty(task, 'name', { value: taskName }); // Set a unique name for debugging
+        return task;
+    });
+
+    // Run all tasks in parallel
+    return gulp.parallel(...tasks);
+}
+
+
+export function buildBackendJSW(options: TaskOptions): TaskType {
+    const folders = ['typescript', ...options.modulesSourcePaths];
+
+    const swcOptions = {
+        jsc: {
+            target: 'es6',
+        },
+    };
+    const { outputDir } = options;
+
+    // Create tasks for each folder
+    const tasks = folders.map((folder) => {
+        const taskName = `build-${folder}`; // Create a unique name for each task
+
+        const task = () =>
+            gulp.src([
+                `${folder}/backend/**/*.jsw.ts`,
+            ])
+            .pipe(swc(swcOptions))
+            .on('error', function (e: Error) {
+                logger.error(`Build of JSW files for ${folder} failed!`);
+                logger.error(`Error: ${e.message}`);
+
+                this.emit('end');
+            })
+            .pipe(rename({ extname: '' }))
+            .pipe(gulp.dest(path.join(outputDir, 'backend')))
+            .on('error', function (e: Error) {
+                logger.error(`Build of JSW files for ${folder} failed!`);
+                logger.error(`Error: ${e.message}`);
+
+                this.emit('end');
+            })
+            .on('end', function () {
+                logger.success(`Build of JSW files for ${folder} succeeded!`);
+            });
+
+        // Register the task with Gulp
+        Object.defineProperty(task, 'name', { value: taskName }); // Set a unique name for debugging
+        return task;
+    });
+
+    // Run all tasks in parallel
+    return gulp.parallel(...tasks);
+}

package/src/tasks/gulp/checks.ts

@@ -0,0 +1,218 @@
+import * as fs from 'fs';
+import { glob } from 'glob';
+
+import * as path from 'path';
+import gulp, { emit } from 'gulp';
+import ts from 'gulp-typescript';
+import { blue, logger, red, yellow } from '../../utils/logger.js';
+import { TaskOptions } from '../../schemas/gulp.js';
+import { TaskType } from '../../schemas/types.js';
+
+// /**
+//  *  Extracts a match from a file
+//  * @param {string} filePath File path
+//  * @param {string} pattern Pattern to match
+//  */
+// function extractMatchFromFile(filePath: string, pattern: string) {
+// 	return new Promise((resolve, reject) => {
+// 		fs.readFile(filePath, 'utf8', (err, data) => {
+// 			if (err){
+// 				reject(err);
+				
+// 				return;
+// 			}
+// 			const regex = new RegExp(pattern);
+// 			const match = regex.exec(data);
+// 			const capturedGroup = match ? match.groups?.page : null;
+// 			resolve(capturedGroup);
+// 		});
+// 	});
+// }
+
+// async function readFilesInFolder(folderPath: string, pattern: string | null, globPattern: string): Promise<Object[]> {
+//     const files = await glob(path.join(folderPath, globPattern));
+//     const filenameList: Object[] = [];
+
+//     for (const file of files) {
+//         if (pattern) {
+//             const capturedGroup = await extractMatchFromFile(file, pattern);
+//             if (capturedGroup) {
+//                 filenameList.push(capturedGroup);
+//             }
+//         } else {
+//             filenameList.push(path.basename(file));
+//         }
+//     }
+
+//     return filenameList;
+// }
+
+/**
+ *  Extracts a match from a file
+ * @param {string} filePath File path
+ * @param {string} pattern Pattern to match
+ */
+function extractMatchFromFile(filePath: string, pattern: string) {
+	return new Promise((resolve, reject) => {
+		fs.readFile(filePath, 'utf8', (err, data) => {
+			if (err){
+				reject(err);
+				
+				return;
+			}
+			const regex = new RegExp(pattern);
+			const match = regex.exec(data);
+			const capturedGroup = match ? match.groups?.page : null;
+			resolve(capturedGroup);
+		});
+	});
+}
+
+/**
+ * Reads files in a folder
+ * @param {string} folderPath Folder path
+ * @param {string} pattern Pattern to match
+ * @param {string} globPattern Glob pattern
+ */
+async function readFilesInFolder(folderPath: string, pattern: string | null, globPattern: string,) {
+	const files = await glob.glob(path.join(folderPath, globPattern));
+	const filenameList: Object[] = [];
+	function traverseFiles(index: number) {
+		if (index === files.length){
+			return;
+		}
+		const file = files[index];
+		if(pattern){
+			if(!file) return
+			extractMatchFromFile(file, pattern)
+				.then((capturedGroup) => {
+					if (capturedGroup){
+						filenameList.push(capturedGroup);
+					}
+					traverseFiles(index + 1);
+				})
+				.catch(() => { throw new Error(`Error reading file: ${file}`); });
+		}
+		if(!pattern){
+			if(!file) return
+			filenameList.push(path.basename(file));
+			traverseFiles(index + 1);
+		}
+	}
+	traverseFiles(0);
+	
+	return filenameList;
+}
+export async function checkPages(fail: boolean, force: boolean) {
+	logger.action('Checking pages...');
+	return new Promise<void>(async (resolve, reject) => {
+		try {
+			const sourcePages = await readFilesInFolder('./.wix/types/', '\\/pages\\/(?<page>.*\\.ts)', '**/*.json',) as string[];
+			const tsPages = await readFilesInFolder('./typescript/pages', null, '**/*.ts',) as string[];
+
+			const sourcePagesSet = new Set(sourcePages);
+			const tsPagesSet = new Set(tsPages);
+			const missingInTs = Array.from(sourcePagesSet).filter((item: string) => !tsPages.includes(item));
+			const obsoleteInTs = Array.from(tsPagesSet).filter((item: string) => !sourcePages.includes(item));
+			if (missingInTs.length > 0){
+				if(!force){
+					const formattedList = missingInTs.map(page => `  • ${page}`).join('\n');
+						logger.error('Missing pages in ts folder::\n' + yellow(formattedList));
+				}
+				if(force) {
+					for (const page of missingInTs) {
+						logger.action('Creating missing page: ', page);
+						fs.writeFileSync(`./typescript/pages/${page}`, '');
+					}
+				}
+			}
+			if (obsoleteInTs.length > 0){
+				if(!force){
+					const formattedList = obsoleteInTs.map(page => `  • ${page}`).join('\n');
+						logger.error('Obsolete pages in TS folder:\n' + yellow(formattedList));
+					}
+				if(force) {
+					for (const page of obsoleteInTs) {
+						logger.action('Deleting obsolete page: ', page);
+						fs.rmSync(`./typescript/pages/${page}`);
+					}
+				}
+			}
+			if (missingInTs.length === 0 && obsoleteInTs.length === 0) {
+				logger.success("All pages are in-sync!");
+			} else if(fail){
+				process.exit(1);
+			};
+		} catch (error) {
+		reject(error);
+		}
+	});
+}
+
+const customReporter: ts.reporter.Reporter = {
+	error: (error, tsInstance) => {
+		if (!error.diagnostic) {
+			logger.error(error.message);
+			return;
+		}
+		const { fullFilename, startPosition } = error;
+		const relativePath = path.relative(process.cwd(), fullFilename ?? '');
+		const line = startPosition ? startPosition.line + 1 : 0;
+		const col = startPosition ? startPosition.character + 1 : 0;
+
+		const message = tsInstance.flattenDiagnosticMessageText(error.diagnostic.messageText, '\n');
+
+		logger.error(`${red.underline(relativePath)}:${yellow(String(line))}:${yellow(String(col))}`);
+		logger.error(`${red('error')} ${yellow(`TS${error.diagnostic.code}`)}: ${message}`);
+	},
+	finish: (results) => {
+		const errorCount = results.transpileErrors + results.semanticErrors + results.declarationErrors;
+		if (errorCount > 0) {
+			logger.error(`${red.bold(`Found ${errorCount} error${errorCount > 1 ? 's' : ''}.`)}`);
+		}
+	},
+};
+
+export function checkTs(options: TaskOptions, watching: boolean = false): TaskType {
+	const folders = ["typescript", ...options.modulesSourcePaths];
+
+	const tasks = folders.map((folder) => {
+    const tsProject = ts.createProject(`./local.tsconfig.json`, {
+		noEmit: true,
+		declaration: false,
+		skipDefaultLibCheck: true,
+    });
+    const taskName = `test-${folder}`;
+
+    const task = (done: gulp.TaskFunctionCallback) => {
+		let hasError = false;
+		const stream = gulp
+			.src([`${folder}/**/*.ts`, `!${folder}/types/**/*.ts`])
+			.pipe(tsProject(customReporter))
+			.on("error", (error) => {
+				hasError = true;
+				logger.error(`Error in ${folder}: ${error.message}`);
+				if (watching) {
+					stream.emit("end");
+				} else {
+					logger.error(`TypeScript check failed for ${folder}.`);
+					process.exit(1); // Exit with error code
+				}
+			}
+		);
+
+		stream.on("end", () => {
+			if (!hasError) {
+				logger.success(`Typescript check for ${folder} succeeded!`);	
+			}
+			stream.emit("finish");
+		});
+		return stream;
+    };
+
+    Object.defineProperty(task, "name", { value: taskName });
+    return task;
+	});
+
+	return gulp.parallel(...tasks);
+}

package/src/tasks/gulp/clean.ts

@@ -0,0 +1,38 @@
+import gulp from 'gulp';
+import clean from 'gulp-clean';
+import { logger } from '../../utils/logger.js';
+import { TaskOptions } from '../../schemas/gulp.js';
+
+export function cleanWix() {	
+    return () => {
+        return gulp.src('./.wix', { read: false, allowEmpty: true })
+		.pipe(clean({ force: true }))
+		.on('error', function (e: Error) {
+			logger.error('Cleaning of .wix failed!');
+			logger.error(`Error: ${e.message}`);
+
+
+			this.emit('end');
+		})
+		.on('end', function() { 
+			logger.success("Cleaning of .wix succeeded!");
+		});
+    }
+}
+
+export function cleanSrc(options: TaskOptions) {
+	const { outputDir } = options;
+
+	return () => {
+		return gulp.src([`${outputDir}/pages`, `${outputDir}/public`, `${outputDir}/backend`], { read: false, allowEmpty: true })
+		.pipe(clean({ force: true }))
+		.on('error', function (e: Error) {
+			logger.error('Cleaning of output files failed!');
+			logger.error(`Error: ${e.message}`);
+			this.emit('end');
+		})
+		.on('end', function() {
+			logger.success('Cleaning of .src succeeded!');
+		});
+	}
+}

package/src/tasks/gulp/copy.ts

@@ -0,0 +1,38 @@
+import gulp from 'gulp';
+import { logger } from '../../utils/logger.js';
+import { TaskOptions } from '../../schemas/gulp.js';
+import { TaskType } from '../../schemas/types.js';
+
+export function copyFiles(options: TaskOptions): TaskType {
+    const folders = ['typescript', ...options.modulesSourcePaths];
+    const tasks = folders.map((folder) => {
+		const { outputDir} = options;
+        const taskName = `copy-${folder}`; // Create a unique name for each task
+        const task = () =>
+			gulp.src([
+				`${folder}/**/*`, 
+				`!${folder}/*tsconfig.json`, 
+				`!${folder}/**/*.ts`, 
+				`!${folder}/**/*.tsx`, 
+				`!${folder}/types/**/**`, 
+				`!${folder}/__mocks__/**/**`, 
+				`!${folder}/styles/**`,
+			])
+			.pipe(gulp.dest(outputDir))
+                .on('error', function (e: Error) {
+                    logger.error(`Copy of files for ${folder} failed!`);
+                    logger.error(`Error: ${e.message}`);
+                    this.emit('end');
+                })
+                .on('end', function () {
+                    logger.success(`Copy of files for ${folder} succeeded!`);
+                });
+
+        // Register the task with Gulp
+        Object.defineProperty(task, 'name', { value: taskName }); // Set a unique name for debugging
+        return task;
+    });
+    const t = gulp.parallel(...tasks);
+    // Run all tasks in parallel
+    return gulp.parallel(...tasks);
+}

package/src/tasks/gulp/helpers.ts

@@ -0,0 +1,18 @@
+import { Effect } from 'effect/index';
+import { Config } from '../../config.js';
+
+export const getModulesSourcePaths = Effect.gen(function* () {
+    const config = yield* Config
+    const data = config.config.lucySettings.modules;
+    const paths: string[] = [];
+    for (const module of Object.keys(data)) {
+        if (!data[module].noCompile) {
+            if (data[module].path) {
+                paths.push(data[module].path);
+            } else {
+                paths.push(module);
+            }
+        }
+    }
+    return paths;
+});

package/src/tasks/gulp/pages.ts

@@ -0,0 +1,43 @@
+import gulp from 'gulp';
+import * as path from 'path';
+import swc from 'gulp-swc';
+import { logger } from '../../utils/logger.js';
+import { TaskOptions } from '../../schemas/gulp.js';
+
+const swcOptions = {
+    jsc: {
+        target: 'es2020',
+        parser: {
+            syntax: "typescript",
+            tsx: true,
+        },
+        preserveAllComments: false,
+        minify: {
+            compress: true // equivalent to {}
+        }
+    },
+};
+
+export function buildPages(options: TaskOptions) {
+    const { outputDir} = options;
+
+    return () => {
+        return gulp.src('typescript/pages/*.ts')
+            .pipe(swc(swcOptions))
+                .on('error', function (e: Error) {
+                    logger.error('Build of Pages files failed!');
+                    logger.error(`Error: ${e.message}`);
+
+                    this.emit('end');
+                })
+                .pipe(gulp.dest(path.join(outputDir, 'pages')))
+                .on('error', function (e: Error) {
+                    logger.error('Build of Pages TS files failed!');
+                    logger.error(`Error: ${e.message}`);
+                    this.emit('end');
+                })
+                .on('end', function() {
+                    logger.success('Build of Pages TS files succeeded!');
+                });
+    };
+}