lucy-cli 0.10.0 → 0.10.1

package/README.md

@@ -30,32 +30,42 @@ Lucy-CLI is designed to streamline the setup and management of TypeScript within
 
 4. **Git Submodule Support**  
    - Includes support for git submodules, providing full type support within submodules and enabling the use of libraries and types across projects.
-
-5. **Configurable Setup**  
+   - To add a submodule, include the following in the `lucy.json` file:
+
+      ``` json
+      "modules": {
+        "<repoName>": {
+          "url": "String",
+          "branch": "String"
+        }
+      }
+      ```
+
+1. **Configurable Setup**  
    - After initialization, Lucy-CLI creates a `lucy-config.json` configuration file where you can modify settings, add dev packages, specify Wix packages, and configure git submodules.
 
-6. **Execute render functions**  
+2. **Execute render functions**  
    - Lucy-CLI can execute render functions located in the backend template folder, allowing you to test render functions locally.
 
-7. **compile sccs files**  
+3. **compile sccs files**  
    - Lucy-CLI can compile scss files to css files.
    - It compiles styles/global.scss file to global.css.
 
-8. **Wix NPM Package Installation**
+4. **Wix NPM Package Installation**
    - Lucy-CLI can install Wix npm packages from the `lucy.json` file in the project directory.
 
-9. **Teting with Vitest**
+5. **Teting with Vitest**
    - Lucy-CLI can run tests with Vitest.
    - It runs tests located backend folder with the file name ending with `.spec.ts`.
    - it creates a code coverage report in the coverage folder in the lib folders and typescript folders.
    - Vitest is looking for mokes in typescript folder and lib folder.
      - You can add additional mock folders in vitest.config.ts file.
 
-10. **Linting with ESLint**
+6.  **Linting with ESLint**
     - Lucy-CLI can lint the code with ESLint.
     - It uses the ESLint configuration in the `.eslintrc.cjs` file in the project directory.  
 
-11. **Add git version during production build**
+7.  **Add git version during production build**
       - Lucy-CLI can add the git version to the production build.
       - It adds the git version to the `public/constant/env.ts` file in the public folder under the key gitTag.
 

package/dist/helpers.d.ts

@@ -1,6 +1,6 @@
-import { ModuleSettings, ProjectSettings } from '.';
+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: Record<string, string>): Promise<void>;
+export declare function gitInit(cwd: string, modules: LucySettings['modules']): 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

@@ -6,6 +6,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import { exec } from 'child_process';
 import os from 'os';
+import fs from 'fs';
 import { blue, green, orange, red, yellow, magenta } from './index.js';
 export async function installPackages(wixPackages, devPackages, cwd, locked) {
     if (locked)
@@ -43,11 +44,19 @@ export async function installPackages(wixPackages, devPackages, cwd, locked) {
     }
 }
 export async function gitInit(cwd, modules) {
-    const git = simpleGit({ baseDir: cwd });
-    for (const [name, url] of Object.entries(modules)) {
+    for (const [name, repo] of Object.entries(modules)) {
         console.log(chalk.green.underline.bold(`Cloning ${name}`));
+        const git = simpleGit({ baseDir: cwd });
         try {
-            await git.submoduleAdd(url, name);
+            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 localGit = simpleGit({ baseDir: `${cwd}/${name}` });
+            await localGit.checkout(repo.branch);
         }
         catch (err) {
             console.log((`💩 ${red.underline.bold("=> Command failed =>")} ${orange(err)}`));

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 #!/usr/bin/env node --no-warnings
 export type LucySettings = {
     modules: {
-        [llibName: string]: string;
+        [llibName: string]: {
+            url: string;
+            branch: string;
+        };
     };
     wixSettings: {
         compilerOptions: {

package/dist/settings.json

@@ -17,7 +17,10 @@
         "@total-typescript/ts-reset": "^0.6.1",
         "@types/node": "^22.9.1",
         "@types/nodemailer": "^6.4.17",
+        "typedoc-github-theme": "^0.2.0",
         "@types/react": "^19.0.0",
+        "@vitest/ui": "^2.1.8",
+        "@vitest/coverage-v8": "^2.1.8",
         "@typescript-eslint/eslint-plugin": "^8.15.0",
         "@typescript-eslint/parser": "^8.15.0",
         "@typescript-eslint/utils": "^8.15.0",

package/files/typedoc.json

@@ -1,4 +1,3 @@
-/** @type { import('typedoc').TypeDocOptionMap & import('typedoc-plugin-merge-modules').Config } */
 {
   "entryPoints": [
     "*/**/*.ts",
@@ -7,22 +6,20 @@
   "entryPointStrategy": "expand",
   "out": "docs",
   "plugin": [
-    "typedoc-github-theme",
+    "typedoc-github-theme"
   ],
   "tsconfig": "local.tsconfig.json",
   "excludeExternals": true,
   "externalPattern": [
     "**/node_modules/**",
     "**/.wix/**",
-    ".wix/**",
+    ".wix/**"
   ],
   "exclude": [
     "./.wix/**/*",
     ".wix/**/*",
     "cypress/**",
-    "**/__mocks__/**",
+    "**/__mocks__/**"
   ],
-  "name": "wix-integraleakademie",
-  // "mergeModulesRenameDefaults": false, // NEW option of TypeDoc added by this plugin
-  // "mergeModulesMergeMode": "project", // NEW option of TypeDoc added by this plugin
+  "name": "Wix-lucy"
 }

package/package.json

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

package/src/helpers.ts

@@ -4,11 +4,13 @@ import { spawnSync } from 'child_process';
 // https://www.sergevandenoever.nl/run-gulp4-tasks-programatically-from-node/
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { ModuleSettings, ProjectSettings } from '.';
+import { LucySettings, ModuleSettings, ProjectSettings } from '.';
 import { exec } from 'child_process';
 import os from 'os';
+import fs from 'fs';
 
 import { blue, green, orange, red, yellow, magenta } from './index.js';
+import { fsync } from 'fs';
 
 export async function installPackages(wixPackages: Record<string, string>, devPackages: Record<string, string>,  cwd: string, locked: boolean ) {
 	if (locked) console.log("🐕" + blue.underline(` => Installing & version locked packages!`));
@@ -47,12 +49,23 @@ export async function installPackages(wixPackages: Record<string, string>, devPa
 	}																
 }
 
-export async function gitInit(cwd: string, modules: Record<string, string>) {
-	const git = simpleGit({ baseDir: cwd });
-	for (const [name, url] of Object.entries(modules)) {
+export async function gitInit(cwd: string, modules: LucySettings['modules']) {
+	for (const [name, repo] of Object.entries(modules)) {
 		console.log(chalk.green.underline.bold(`Cloning ${name}`));
+        const git = simpleGit({ baseDir: cwd });
+
 		try {
-			await git.submoduleAdd(url, name)
+            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 localGit = simpleGit({ baseDir: `${cwd}/${name}` });
+            await localGit.checkout(repo.branch);
 		} catch (err) {
 			console.log((`💩 ${red.underline.bold("=> Command failed =>")} ${orange(err)}`));
 		} finally {	

package/src/index.ts

@@ -17,7 +17,10 @@ import { spawnSync } from 'child_process';
 
 export type LucySettings = {
 	modules: {
-		[llibName: string]: string;
+		[llibName: string]: {
+			url: string;
+			branch: string;
+		};
 	};
 	wixSettings: {
 		compilerOptions: {