lucy-cli 1.2.3 → 1.2.5

package/README.md

@@ -58,8 +58,10 @@ Lucy-CLI is designed to streamline the setup and management of TypeScript within
       ``` json
       "modules": {
         "<repoName>": {
-          "url": "String",
-          "branch": "String"
+            "url": "String",
+            "branch": "String",
+            "path": "String", // Optional, specifies the path where the submodule should be cloned
+            "noCompile": true // Optional, if true, the module will not be compiled
         }
       }
       ```

package/dist/Gulpfile.d.ts

@@ -17,6 +17,7 @@ export type TaskOptions = {
     pageSettings: typeof pageSettings;
     publicSettings: typeof publicSettings;
     modulesSync: Record<string, string> | undefined;
+    modulesSourcePaths: string[];
     cwd: string;
     isWatching?: boolean;
 };

package/dist/Gulpfile.js

@@ -23,7 +23,7 @@ import { addTypes, updateWixTypes } from './gulp/types.js';
 import { setProdConfig } from './gulp/pipeline.js';
 import { watchAll } from './gulp/watchers.js';
 import { blue, green, magenta, orange, red } from './index.js';
-import { getModulesSync } from './gulp/helpers.js';
+import { getModulesSourcePaths, getModulesSync } from './gulp/helpers.js';
 const sass = gulpSass(dartSass);
 const outputDir = './src';
 const userHomeDir = os.homedir();
@@ -44,6 +44,7 @@ const taskOptions = {
     replaceOptions,
     cwd: process.cwd(),
     modulesSync: getModulesSync(),
+    modulesSourcePaths: getModulesSourcePaths(),
 };
 const watchTaskOptions = { ...taskOptions, isWatching: true };
 gulp.task('check-ts', gulp.parallel(checkTs(taskOptions)));

package/dist/gulp/backend.js

@@ -19,12 +19,7 @@ const swcOptions = {
     },
 };
 export function buildBackend(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     const { outputDir } = options;
     // Create tasks for each folder
     const tasks = folders.map((folder) => {
@@ -58,12 +53,7 @@ export function buildBackend(options) {
     return gulp.parallel(...tasks);
 }
 export function buildBackendJSW(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     const swcOptions = {
         jsc: {
             target: 'es6',

package/dist/gulp/checks.js

@@ -171,12 +171,7 @@ const customReporter = {
     },
 };
 export function checkTs(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     // Create tasks for each folder
     const tasks = folders.map((folder) => {
         const tsProject = ts.createProject(`./local.tsconfig.json`, { noEmit: true, declaration: false, skipDefaultLibCheck: true });

package/dist/gulp/copy.js

@@ -1,12 +1,7 @@
 import gulp from 'gulp';
 import { blue, orange, red } from '../index.js';
 export function copyFiles(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     // Create tasks for each folder
     const tasks = folders.map((folder) => {
         const { outputDir } = options;

package/dist/gulp/helpers.d.ts

@@ -1 +1,2 @@
 export declare function getModulesSync(): Record<string, string> | undefined;
+export declare function getModulesSourcePaths(): string[];

package/dist/gulp/helpers.js

@@ -5,3 +5,20 @@ export function getModulesSync() {
     const fileContent = fs.readFileSync(absolutePath, 'utf8');
     return JSON.parse(fileContent).modules;
 }
+export function getModulesSourcePaths() {
+    const absolutePath = path.resolve('./lucy.json');
+    const fileContent = fs.readFileSync(absolutePath, 'utf8');
+    const data = JSON.parse(fileContent).modules;
+    const paths = [];
+    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/dist/gulp/public.js

@@ -16,12 +16,7 @@ const swcOptions = {
     },
 };
 export function buildPublic(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     const { outputDir } = options;
     // Create tasks for each folder
     const tasks = folders.map((folder) => {

package/dist/gulp/styles.js

@@ -2,35 +2,38 @@ import gulp from 'gulp';
 import { blue, orange, red } from '../index.js';
 export function compileScss(options) {
     const folders = ['typescript'];
-    // if (options.modulesSync){
-    //     for (const module of Object.keys(options.modulesSync)) {
-    //         folders.push(module);
-    //     }
-    // }
     const { sass, outputDir } = options;
-    // Create tasks for each folder
-    const tasks = folders.map((folder) => {
-        const taskName = `compile_sass-${folder}`; // Create a unique name for each task
-        const task = () => gulp.src(['typescript/styles/global.scss'])
-            .pipe(sass().on('error', sass.logError))
-            .on('error', function (e) {
-            console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange(folder)} failed!`));
-            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-            this.emit('end');
-        })
-            .pipe(gulp.dest(`${outputDir}/styles`))
-            .on('error', function (e) {
-            console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange(folder)} failed!`));
-            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-            this.emit('end');
-        })
-            .on('end', function () {
-            console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange(folder)} succeeded!`));
-        });
-        // Register the task with Gulp
-        Object.defineProperty(task, 'name', { value: taskName }); // Set a unique name for debugging
-        return task;
+    const buildWixScss = () => gulp.src(['typescript/styles/global.scss'], { allowEmpty: true })
+        .pipe(sass().on('error', sass.logError))
+        .on('error', function (e) {
+        console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange('global.scs')} failed!`));
+        console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+        this.emit('end');
+    })
+        .pipe(gulp.dest(`${outputDir}/styles`))
+        .on('error', function (e) {
+        console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange('global.scs')} failed!`));
+        console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+        this.emit('end');
+    })
+        .on('end', function () {
+        console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange('global.scs')} succeeded!`));
     });
-    // Run all tasks in parallel
-    return gulp.parallel(...tasks);
+    const buildScss = () => gulp.src(['typescript/public/scss/app.scss'], { allowEmpty: true })
+        .pipe(sass().on('error', sass.logError))
+        .on('error', function (e) {
+        console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange('app.scss')} failed!`));
+        console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+        this.emit('end');
+    })
+        .pipe(gulp.dest(`${outputDir}/public/css`))
+        .on('error', function (e) {
+        console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange('app.scss')} failed!`));
+        console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+        this.emit('end');
+    })
+        .on('end', function () {
+        console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange('app.scss')} succeeded!`));
+    });
+    return gulp.parallel(buildWixScss, buildScss);
 }

package/dist/gulp/templates.js

@@ -2,12 +2,7 @@ import gulp from 'gulp';
 import exec from 'gulp-exec';
 import { blue, orange, red } from '../index.js';
 export function previewTemplates(options) {
-    const folders = ['typescript'];
-    if (options.modulesSync) {
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
     const taskOpt = {
         continueOnError: true,
     };

package/dist/helpers.js

@@ -92,23 +92,24 @@ export async function gitInit(cwd, modules, force) {
     const dotGitmodulesPath = path.join(cwd, '.gitmodules');
     for (const [name, repo] of Object.entries(modules)) {
         console.log(chalk.green.underline.bold(`Processing submodule ${name}`));
+        const clonePath = repo.path || name;
         try {
-            const isRegistered = await isSubmoduleRegistered(git, name);
+            const isRegistered = await isSubmoduleRegistered(git, clonePath);
             // Check that .gitmodules exists AND contains the entry for this specific submodule.
             const isConfiguredInFile = fs.existsSync(dotGitmodulesPath) &&
-                fs.readFileSync(dotGitmodulesPath, 'utf-8').includes(`[submodule "${name}"]`);
+                fs.readFileSync(dotGitmodulesPath, 'utf-8').includes(`[submodule "${clonePath}"]`);
             // Add/repair if not configured in .gitmodules, or if forced by the user.
             if (!isConfiguredInFile || force) {
-                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name}...`)}`);
+                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name} at ${clonePath}...`)}`);
                 // If git already has a config entry, we must use --force to repair it.
-                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, name];
+                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, clonePath];
                 await git.subModule(submoduleArgs);
             }
             else {
-                console.log(`🐕 ${blue.underline(`Submodule ${name} already registered. Skipping add.`)}`);
+                console.log(`🐕 ${blue.underline(`Submodule ${name} at ${clonePath} already registered. Skipping add.`)}`);
             }
-            await git.submoduleUpdate(['--init', '--recursive', name]);
-            await simpleGit({ baseDir: path.join(cwd, name) }).checkout(repo.branch);
+            await git.submoduleUpdate(['--init', '--recursive', clonePath]);
+            await simpleGit({ baseDir: path.join(cwd, clonePath) }).checkout(repo.branch);
         }
         catch (err) {
             console.log((`💩 ${red.underline.bold(`=> Command failed for submodule ${name} =>`)} ${orange(err)}`));

package/dist/index.d.ts

@@ -1,9 +1,17 @@
 #!/usr/bin/env node --no-warnings
+export type ModulesSettings = {
+    packageRoot: string;
+    targetFolder: string;
+    args: string[];
+    settings: LucySettings;
+};
 export type LucySettings = {
     modules: {
-        [llibName: string]: {
+        [libName: string]: {
             url: string;
             branch: string;
+            path?: string;
+            noCompile?: boolean;
         };
     };
     wixSettings: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "lucy-cli",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Lucy Framework for WIX Studio Editor",
   "main": ".dist/index.js",
   "scripts": {

package/src/Gulpfile.ts

@@ -21,7 +21,7 @@ import { addTypes, updateWixTypes } from './gulp/types.js';
 import { setProdConfig } from './gulp/pipeline.js';
 import { watchAll } from './gulp/watchers.js';
 import { ModuleSettings, ProjectSettings, blue, green, magenta, orange, red } from './index.js';
-import { getModulesSync } from './gulp/helpers.js';
+import { getModulesSourcePaths, getModulesSync } from './gulp/helpers.js';
 
 const sass = gulpSass(dartSass);
 
@@ -38,6 +38,7 @@ export type TaskOptions = {
 	pageSettings: typeof pageSettings,
 	publicSettings: typeof publicSettings,
 	modulesSync: Record<string, string> | undefined;
+	modulesSourcePaths: string[];
 	cwd: string;
 	isWatching?: boolean;
 }
@@ -67,6 +68,7 @@ const taskOptions: TaskOptions = {
 	replaceOptions,
 	cwd: process.cwd(),
 	modulesSync: getModulesSync(),
+	modulesSourcePaths: getModulesSourcePaths(),
 }
 
 const watchTaskOptions: TaskOptions = { ...taskOptions, isWatching: true };

package/src/gulp/backend.ts

@@ -23,12 +23,7 @@ const swcOptions = {
 };
 
 export function buildBackend(options: TaskOptions) {
-    const folders = ['typescript'];
-    if (options.modulesSync){
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
 
     const { outputDir } = options;
 
@@ -70,12 +65,8 @@ export function buildBackend(options: TaskOptions) {
 
 
 export function buildBackendJSW(options: TaskOptions) {
-    const folders = ['typescript'];
-    if (options.modulesSync){
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
+
     const swcOptions = {
         jsc: {
             target: 'es6',

package/src/gulp/checks.ts

@@ -186,12 +186,8 @@ const customReporter: ts.reporter.Reporter = {
 };
 
 export function checkTs(options: TaskOptions) {
-    const folders = ['typescript'];
-    if (options.modulesSync){
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
+
 
     // Create tasks for each folder
     const tasks = folders.map((folder) => {

package/src/gulp/copy.ts

@@ -4,12 +4,7 @@ import { TaskOptions } from '../Gulpfile';
 import { blue, orange, red } from '../index.js';
 
 export function copyFiles(options: TaskOptions) {
-    const folders = ['typescript'];
-    if (options.modulesSync){
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
 
     // Create tasks for each folder
     const tasks = folders.map((folder) => {

package/src/gulp/helpers.ts

@@ -6,4 +6,21 @@ export function getModulesSync(): Record<string, string> | undefined {
     const absolutePath = path.resolve('./lucy.json');
     const fileContent = fs.readFileSync(absolutePath, 'utf8') as any;
     return JSON.parse(fileContent).modules;
+}
+
+export function getModulesSourcePaths(): string[] {
+    const absolutePath = path.resolve('./lucy.json');
+    const fileContent = fs.readFileSync(absolutePath, 'utf8') as any;
+    const data =  JSON.parse(fileContent).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/gulp/public.ts

@@ -19,12 +19,7 @@ const swcOptions = {
 };
 
 export function buildPublic(options: TaskOptions) {
-    const folders = ['typescript'];
-    if (options.modulesSync){
-        for (const module of Object.keys(options.modulesSync)) {
-            folders.push(module);
-        }
-    }
+    const folders = ['typescript', ...options.modulesSourcePaths];
 
     const { outputDir } = options;
 

package/src/gulp/styles.ts

@@ -5,42 +5,42 @@ import { blue, orange, red } from '../index.js';
 
 export function compileScss(options: TaskOptions) {
     const folders = ['typescript'];
-    // if (options.modulesSync){
-    //     for (const module of Object.keys(options.modulesSync)) {
-    //         folders.push(module);
-    //     }
-    // }
 
     const { sass, outputDir} = options;
 
+    const buildWixScss =  () => gulp.src(['typescript/styles/global.scss'], { allowEmpty: true })
+        .pipe(sass().on('error', sass.logError))
+        .on('error', function (e: Error) {
+            console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange('global.scs')} failed!`));
+            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+            this.emit('end');
+        })
+        .pipe(gulp.dest(`${outputDir}/styles`))
+        .on('error', function (e: Error) {
+            console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange('global.scs')} failed!`));
+            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+            this.emit('end');
+        })
+        .on('end', function () {
+            console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange('global.scs')} succeeded!`));
+        });
 
-    // Create tasks for each folder
-    const tasks = folders.map((folder) => {
-        const taskName = `compile_sass-${folder}`; // Create a unique name for each task
-
-        const task = () =>
-            gulp.src(['typescript/styles/global.scss'])
-                .pipe(sass().on('error', sass.logError))
-                .on('error', function (e: Error) {
-                    console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange(folder)} failed!`));
-                    console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-                    this.emit('end');
-                })
-                .pipe(gulp.dest(`${outputDir}/styles`))
-                .on('error', function (e: Error) {
-                    console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange(folder)} failed!`));
-                    console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-                    this.emit('end');
-                })
-                .on('end', function () {
-                    console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange(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);
+    const buildScss =  () => gulp.src(['typescript/public/scss/app.scss'], { allowEmpty: true })
+        .pipe(sass().on('error', sass.logError))
+        .on('error', function (e: Error) {
+            console.log("💩" + red.underline.bold(` => Build of SCSS files for ${orange('app.scss')} failed!`));
+            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+            this.emit('end');
+        })
+        .pipe(gulp.dest(`${outputDir}/public/css`))
+        .on('error', function (e: Error) {
+            console.log("💩" + red.underline.bold(` => Compiling of scss files for ${orange('app.scss')} failed!`));
+            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+            this.emit('end');
+        })
+        .on('end', function () {
+            console.log("🐶" + blue.underline(` => Compiling of scss files for ${orange('app.scss')} succeeded!`));
+        });
+        
+    return gulp.parallel(buildWixScss, buildScss);
 }

package/src/gulp/templates.ts

@@ -4,12 +4,7 @@ import exec from 'gulp-exec';
 import { blue, orange, red } from '../index.js';
 
 export function previewTemplates(options: TaskOptions) {
-        const folders = ['typescript'];
-        if (options.modulesSync){
-            for (const module of Object.keys(options.modulesSync)) {
-                folders.push(module);
-            }
-        }
+        const folders = ['typescript', ...options.modulesSourcePaths];
         
         const taskOpt = {
             continueOnError: true,

package/src/helpers.ts

@@ -102,25 +102,26 @@ export async function gitInit(cwd: string, modules: LucySettings['modules'] | un
 
 	for (const [name, repo] of Object.entries(modules)) {
 		console.log(chalk.green.underline.bold(`Processing submodule ${name}`));
+		const clonePath = repo.path || name;
 
 		try {
-			const isRegistered = await isSubmoduleRegistered(git, name);
+			const isRegistered = await isSubmoduleRegistered(git, clonePath);
 			// Check that .gitmodules exists AND contains the entry for this specific submodule.
 			const isConfiguredInFile = fs.existsSync(dotGitmodulesPath) &&
-				fs.readFileSync(dotGitmodulesPath, 'utf-8').includes(`[submodule "${name}"]`);
+				fs.readFileSync(dotGitmodulesPath, 'utf-8').includes(`[submodule "${clonePath}"]`);
 
             // Add/repair if not configured in .gitmodules, or if forced by the user.
             if (!isConfiguredInFile || force) {
-                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name}...`)}`);
+                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name} at ${clonePath}...`)}`);
                 // If git already has a config entry, we must use --force to repair it.
-                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, name];
+                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, clonePath];
                 await git.subModule(submoduleArgs);
             } else {
-                console.log(`🐕 ${blue.underline(`Submodule ${name} already registered. Skipping add.`)}`);
+                console.log(`🐕 ${blue.underline(`Submodule ${name} at ${clonePath} already registered. Skipping add.`)}`);
             }
 
-            await git.submoduleUpdate(['--init', '--recursive', name]);
-            await simpleGit({ baseDir: path.join(cwd, name) }).checkout(repo.branch);
+            await git.submoduleUpdate(['--init', '--recursive', clonePath]);
+            await simpleGit({ baseDir: path.join(cwd, clonePath) }).checkout(repo.branch);
 		} catch (err) {
 			console.log((`💩 ${red.underline.bold(`=> Command failed for submodule ${name} =>`)} ${orange(err)}`));
 		}

package/src/index.ts

@@ -16,11 +16,19 @@ import { prepare } from './prepare.js';
 import { spawn, spawnSync } from 'child_process';
 import os from 'os';
 
+export type ModulesSettings = {
+	packageRoot: string;
+	targetFolder: string;
+	args: string[];
+	settings: LucySettings;
+}
 export type LucySettings = {
 	modules: {
-		[llibName: string]: {
+		[libName: string]: {
 			url: string;
 			branch: string;
+			path?: string;
+			noCompile?: boolean;
 		};
 	};
 	wixSettings: {