lucy-cli 1.2.2 → 1.2.3

package/dist/helpers.d.ts

@@ -1,6 +1,6 @@
 import { LucySettings, ModuleSettings, ProjectSettings } from '.';
 export declare function installPackages(wixPackages: Record<string, string>, devPackages: Record<string, string>, cwd: string, locked: boolean): Promise<void>;
-export declare function gitInit(cwd: string, modules: LucySettings['modules']): Promise<void>;
+export declare function gitInit(cwd: string, modules: LucySettings['modules'] | undefined, force: boolean): Promise<void>;
 export declare function runGulp(moduleSettings: ModuleSettings, projectSettings: ProjectSettings, task: string): Promise<void>;
 /**
  * Clean up and run a command before exiting the process.

package/dist/helpers.js

@@ -69,29 +69,52 @@ export async function installPackages(wixPackages, devPackages, cwd, locked) {
         console.log("🐕" + red.underline(` => Some packages failed to install!`));
     }
 }
-export async function gitInit(cwd, modules) {
+async function isSubmoduleRegistered(git, submoduleName) {
+    try {
+        const urlConfig = await git.getConfig(`submodule.${submoduleName}.url`);
+        return !!urlConfig.value;
+    }
+    catch (e) {
+        // simple-git throws an error if the config key doesn't exist
+        return false;
+    }
+}
+export async function gitInit(cwd, modules, force) {
+    const git = simpleGit({ baseDir: cwd });
+    if (!(await git.checkIsRepo())) {
+        console.log(chalk.yellow('Project is not a git repository. Initializing...'));
+        await git.init();
+    }
+    if (!modules) {
+        console.log(chalk.yellow('No submodules defined in settings, skipping.'));
+        return;
+    }
+    const dotGitmodulesPath = path.join(cwd, '.gitmodules');
     for (const [name, repo] of Object.entries(modules)) {
-        console.log(chalk.green.underline.bold(`Cloning ${name}`));
-        const git = simpleGit({ baseDir: cwd });
+        console.log(chalk.green.underline.bold(`Processing submodule ${name}`));
         try {
-            const repoPath = path.resolve(cwd, name);
-            if (!fs.existsSync(repoPath)) {
-                await git.submoduleAdd(repo.url, name);
+            const isRegistered = await isSubmoduleRegistered(git, name);
+            // 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}"]`);
+            // Add/repair if not configured in .gitmodules, or if forced by the user.
+            if (!isConfiguredInFile || force) {
+                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name}...`)}`);
+                // If git already has a config entry, we must use --force to repair it.
+                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, name];
+                await git.subModule(submoduleArgs);
             }
-            if (fs.existsSync(repoPath)) {
-                console.log(`🐕 ${blue.underline(' => Module already cloned!')}`);
+            else {
+                console.log(`🐕 ${blue.underline(`Submodule ${name} already registered. Skipping add.`)}`);
             }
-            const localGit = simpleGit({ baseDir: `${cwd}/${name}` });
-            await localGit.checkout(repo.branch);
+            await git.submoduleUpdate(['--init', '--recursive', name]);
+            await simpleGit({ baseDir: path.join(cwd, name) }).checkout(repo.branch);
         }
         catch (err) {
-            console.log((`💩 ${red.underline.bold("=> Command failed =>")} ${orange(err)}`));
-        }
-        finally {
-            console.log("🐕" + blue.underline(` => Cloned ${orange(name)}`));
+            console.log((`💩 ${red.underline.bold(`=> Command failed for submodule ${name} =>`)} ${orange(err)}`));
         }
     }
-    console.log("🐶" + green.underline(' => All Modules cloned!'));
+    console.log("🐶" + green.underline(' => All modules processed!'));
 }
 export async function runGulp(moduleSettings, projectSettings, task) {
     // Get the directory name of the current module

package/dist/init.js

@@ -59,7 +59,7 @@ export async function init(moduleSettings, projectSettings) {
     await installPackages(moduleSettings.settings.wixPackages, moduleSettings.settings.devPackages, moduleSettings.targetFolder, moduleSettings.lockVersion);
     await editJson(join(moduleSettings.targetFolder, 'jsconfig.json'), ['compilerOptions', 'exclude'], [moduleSettings.settings.wixSettings.compilerOptions, moduleSettings.settings.wixSettings.exclude]);
     await editJson(join(moduleSettings.targetFolder, 'typedoc.json'), ['name'], [path.basename(moduleSettings.targetFolder)]);
-    await gitInit(moduleSettings.targetFolder, moduleSettings.settings.modules);
+    await gitInit(moduleSettings.targetFolder, moduleSettings.settings.modules, moduleSettings.force);
     moduleSettings.settings.initialized = true;
     const eslintrcPath = join(moduleSettings.targetFolder, '.eslintrc.json');
     if (existsSync(eslintrcPath)) {

package/dist/prepare.js

@@ -14,6 +14,6 @@ export async function prepare(moduleSettings, projectSettings) {
         return;
     }
     await installPackages(projectSettings.lucySettings.wixPackages, projectSettings.lucySettings.devPackages, moduleSettings.targetFolder, moduleSettings.lockVersion);
-    await gitInit(moduleSettings.targetFolder, projectSettings?.lucySettings?.modules);
+    await gitInit(moduleSettings.targetFolder, projectSettings?.lucySettings?.modules, moduleSettings.force);
     console.log(chalk.greenBright.underline('🐶 => Prepare done!'));
 }

package/package.json

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

package/src/helpers.ts

@@ -1,5 +1,5 @@
 import chalk from 'chalk';
-import { simpleGit } from 'simple-git';
+import { simpleGit, SimpleGit } from 'simple-git';
 import { spawnSync, exec } from 'child_process';
 // https://www.sergevandenoever.nl/run-gulp4-tasks-programatically-from-node/
 import path, { join } from 'path';
@@ -75,30 +75,57 @@ export async function installPackages(wixPackages: Record<string, string>, devPa
 	}																
 }
 
-export async function gitInit(cwd: string, modules: LucySettings['modules']) {
+async function isSubmoduleRegistered(git: SimpleGit, submoduleName: string): Promise<boolean> {
+    try {
+        const urlConfig = await git.getConfig(`submodule.${submoduleName}.url`);
+        return !!urlConfig.value;
+    } catch (e) {
+        // simple-git throws an error if the config key doesn't exist
+        return false;
+    }
+}
+
+export async function gitInit(cwd: string, modules: LucySettings['modules'] | undefined, force: boolean) {
+	const git = simpleGit({ baseDir: cwd });
+
+    if (!(await git.checkIsRepo())) {
+        console.log(chalk.yellow('Project is not a git repository. Initializing...'));
+        await git.init();
+    }
+
+	if (!modules) {
+		console.log(chalk.yellow('No submodules defined in settings, skipping.'));
+		return;
+	}
+
+	const dotGitmodulesPath = path.join(cwd, '.gitmodules');
+
 	for (const [name, repo] of Object.entries(modules)) {
-		console.log(chalk.green.underline.bold(`Cloning ${name}`));
-        const git = simpleGit({ baseDir: cwd });
+		console.log(chalk.green.underline.bold(`Processing submodule ${name}`));
 
 		try {
-            const repoPath = path.resolve(cwd, name);
-            if (!fs.existsSync(repoPath)) {
-                await git.submoduleAdd(repo.url, name)
-            }
-
-            if (fs.existsSync(repoPath)) {
-                console.log(`🐕 ${blue.underline(' => Module already cloned!')}`);
+			const isRegistered = await isSubmoduleRegistered(git, name);
+			// 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}"]`);
+
+            // Add/repair if not configured in .gitmodules, or if forced by the user.
+            if (!isConfiguredInFile || force) {
+                console.log(`🐕 ${blue.underline(`Adding/updating submodule ${name}...`)}`);
+                // If git already has a config entry, we must use --force to repair it.
+                const submoduleArgs = ['add', ...(force || isRegistered ? ['--force'] : []), repo.url, name];
+                await git.subModule(submoduleArgs);
+            } else {
+                console.log(`🐕 ${blue.underline(`Submodule ${name} already registered. Skipping add.`)}`);
             }
 
-            const localGit = simpleGit({ baseDir: `${cwd}/${name}` });
-            await localGit.checkout(repo.branch);
+            await git.submoduleUpdate(['--init', '--recursive', name]);
+            await simpleGit({ baseDir: path.join(cwd, name) }).checkout(repo.branch);
 		} catch (err) {
-			console.log((`💩 ${red.underline.bold("=> Command failed =>")} ${orange(err)}`));
-		} finally {	
-			console.log("🐕" + blue.underline(` => Cloned ${orange(name)}`));
+			console.log((`💩 ${red.underline.bold(`=> Command failed for submodule ${name} =>`)} ${orange(err)}`));
 		}
 	}
-	console.log("🐶" + green.underline(' => All Modules cloned!'));
+	console.log("🐶" + green.underline(' => All modules processed!'));
 }
 
 

package/src/init.ts

@@ -72,7 +72,7 @@ export async function init(moduleSettings: ModuleSettings, projectSettings: Proj
 	await editJson(join(moduleSettings.targetFolder, 'jsconfig.json'), ['compilerOptions', 'exclude'], [moduleSettings.settings.wixSettings.compilerOptions, moduleSettings.settings.wixSettings.exclude]);
 	await editJson(join(moduleSettings.targetFolder, 'typedoc.json'), ['name'], [path.basename(moduleSettings.targetFolder)]);
 
-	await gitInit(moduleSettings.targetFolder, moduleSettings.settings.modules);
+	await gitInit(moduleSettings.targetFolder, moduleSettings.settings.modules, moduleSettings.force);
 
 	moduleSettings.settings.initialized = true;
 

package/src/prepare.ts

@@ -18,7 +18,7 @@ export async function prepare(moduleSettings: ModuleSettings, projectSettings: P
 
 	await installPackages(projectSettings.lucySettings.wixPackages, projectSettings.lucySettings.devPackages, moduleSettings.targetFolder, moduleSettings.lockVersion);
 
-	await gitInit(moduleSettings.targetFolder, projectSettings?.lucySettings?.modules);
+	await gitInit(moduleSettings.targetFolder, projectSettings?.lucySettings?.modules, moduleSettings.force);
 
 	console.log(chalk.greenBright.underline('🐶 => Prepare done!'));
 }