lucy-cli 0.8.0 → 0.8.2

package/README.md

@@ -8,6 +8,13 @@ Lucy-CLI was developed out of a personal need to gain full TypeScript support fo
 
 Lucy, my loyal dog, accompanied me during long nights working on a major project where I developed this CLI. Her companionship and resilience inspired the name "Lucy-CLI."
 
+## CAUTION: Thing to keep in mind before using Lucy-CLI
+
+This CLI is still in development and may have bugs. Please use it with caution.
+Libraries are expected to have the same folder structure as  the main typescript folder except for the pages folder.
+(backend, public, styles)
+The lucy CLI is opinionated and may not work with all projects.
+
 ## What It Does
 
 Lucy-CLI is designed to streamline the setup and management of TypeScript within Wix Velo projects, providing tools to enhance code quality and reduce development time. Here’s what it offers:
@@ -27,7 +34,28 @@ Lucy-CLI is designed to streamline the setup and management of TypeScript within
 5. **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**  
+   - Lucy-CLI can execute render functions located in the backend template folder, allowing you to test render functions locally.
+
+7. **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**
+   - Lucy-CLI can install Wix npm packages from the `lucy.json` file in the project directory.
+
+9. **Teting with Jest**
+   - Lucy-CLI can run tests with Jest.
+   - 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.
+
+10. **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**
+      - 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.
 
 ## Commands & Options
 

package/dist/gulp/backend.js

@@ -13,6 +13,7 @@ export function buildBackend(options) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
     // Create tasks for each folder
     const tasks = folders.map((folder) => {
@@ -51,6 +52,7 @@ export function buildBackendJSW(options) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
     // Create tasks for each folder
     const tasks = folders.map((folder) => {

package/dist/gulp/pages.js

@@ -6,6 +6,7 @@ export function buildPages(options) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild, // enables the esbuild's incremental build
+        pipe: true, // enables the esbuild's pipe mode
     });
     return () => {
         return gulp.src('typescript/pages/*.ts')

package/dist/gulp/public.js

@@ -12,6 +12,7 @@ export function buildPublic(options) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
     // Create tasks for each folder
     const tasks = folders.map((folder) => {

package/dist/gulp/types.js

@@ -239,26 +239,17 @@ function processJson(obj) {
     }
 }
 function cleanTsConfig(json) {
-    // Process the paths object to remove duplicates
+    // const paths: Record<string, string[]> = {};
     if (json.compilerOptions?.paths) {
-        for (const key in json.compilerOptions.paths) {
-            if (Array.isArray(json.compilerOptions.paths[key])) {
-                const uniquePaths = [...new Set(json.compilerOptions.paths[key])];
-                json.compilerOptions.paths[key] = uniquePaths.length > 0 ? uniquePaths : undefined;
-            }
+        for (const [key, value] of Object.entries(json.compilerOptions.paths)) {
+            const uniquePaths = new Set(value);
+            json.compilerOptions.paths[key] = Array.from(uniquePaths);
+            // paths[key] = Array.from(uniquePaths);
         }
+        // json.compilerOptions.paths = paths;
     }
-    // Process the include array to remove duplicates
-    if (Array.isArray(json.include)) {
-        const uniqueIncludes = [...new Set(json.include)];
-        json.include = uniqueIncludes.length > 0 ? uniqueIncludes : undefined;
-    }
-    // Remove empty or undefined fields
-    if (json.compilerOptions?.paths) {
-        json.compilerOptions.paths = Object.fromEntries(Object.entries(json.compilerOptions.paths).filter(([_, value]) => value !== undefined));
-    }
-    if (json.include?.length === 0) {
-        delete json.include;
-    }
+    json.include = Array.from(new Set(json.include));
+    json.exclude = Array.from(new Set(json.exclude));
+    json.files = Array.from(new Set(json.files));
     return json;
 }

package/dist/models.d.ts

@@ -0,0 +1,37 @@
+export type TSConfig = {
+    compilerOptions?: {
+        target?: string;
+        module?: string;
+        lib?: string[];
+        outDir?: string;
+        rootDir?: string;
+        strict?: boolean;
+        esModuleInterop?: boolean;
+        allowJs?: boolean;
+        checkJs?: boolean;
+        declaration?: boolean;
+        declarationMap?: boolean;
+        sourceMap?: boolean;
+        removeComments?: boolean;
+        noImplicitAny?: boolean;
+        moduleResolution?: "node" | "classic";
+        resolveJsonModule?: boolean;
+        skipLibCheck?: boolean;
+        types?: string[];
+        typeRoots?: string[];
+        jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
+        incremental?: boolean;
+        noEmit?: boolean;
+        paths?: Record<string, string[]>;
+        [key: string]: any;
+    };
+    include?: string[];
+    exclude?: string[];
+    files?: string[];
+    extends?: string;
+    references?: {
+        path: string;
+    }[];
+    compileOnSave?: boolean;
+    [key: string]: any;
+};

package/dist/models.js

@@ -0,0 +1 @@
+export {};

package/files/.eslintrc.cjs

@@ -7,6 +7,7 @@ module.exports = {
 	},		
 	ignorePatterns: ['src/**/*', 'typescript/types/backend/**/*', 'typescript/types/pages/**/*', 'typescript/types/public/**/*', 'typescript/types/node/**/*', '.wix/**/*', 'coverage/**/*', 'docs/**/*'],
 	rules: {
+		'no-static-block': 'error',
 		quotes: [2, 'single', { 'avoidEscape': true, 'allowTemplateLiterals': true }],
 		curly: ['error', 'multi-line'],
 		'simple-import-sort/imports': 'error',
@@ -87,6 +88,14 @@ module.exports = {
 			}
 		],
 	},
+    overrides: [
+        {
+            files: ['**/*.tsx', '**/*.ts'],
+            rules: {
+                'no-static-block': 'error'
+            }
+        }
+    ],
 	root: true,
 	env: {
 		es6: true,

package/files/typescript/templates/render.ts

@@ -0,0 +1,32 @@
+import * as fs from 'fs';
+
+
+export interface RenderToFsOPtions {
+    renderer: (arg0: any, arg1: any) => Promise<string>;
+    dataSource: string;
+    destination: string;
+}
+/**
+ * Render E-Mail to file system
+ * @param {RenderToFsOPtions} options Preview Options
+ * @returns {Promise<void>}
+ */
+export async function renderToFs(options: RenderToFsOPtions): Promise<void> {
+	if (process.env.NODE_ENV === 'production' || process.env.NODE_ENV === 'development') return;
+	console.log('rendered', process.env.NODE_ENV, options);
+	fs.readFile(`typescript/backend/templates/data/${options.dataSource}`, 'utf8', async (err, data) => {
+		if (err){
+			console.error('Template Rendere => ', err);
+			
+			return;
+		}
+		const fakeDate = JSON.parse(data) as any; 
+		console.log('fakeDate', fakeDate);
+		const html = await options.renderer(fakeDate, 'de');
+		fs.writeFile(`typescript/backend/templates/preview/${options.destination}.html`, html, err => {
+			if (err){
+				console.error(err);
+			}
+		});
+	});
+}

package/package.json

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

package/src/gulp/backend.ts

@@ -16,6 +16,7 @@ export function buildBackend(options: TaskOptions) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
 
     // Create tasks for each folder
@@ -64,6 +65,7 @@ export function buildBackendJSW(options: TaskOptions) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
 
     // Create tasks for each folder

package/src/gulp/copy.ts

@@ -15,7 +15,6 @@ export function copyFiles(options: TaskOptions) {
     const tasks = folders.map((folder) => {
 		const { outputDir} = options;
 
-
         const taskName = `copy-${folder}`; // Create a unique name for each task
 
         const task = () =>

package/src/gulp/pages.ts

@@ -8,6 +8,7 @@ export function buildPages(options: TaskOptions) {
     const { outputDir, enableIncrementalBuild} = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild, // enables the esbuild's incremental build
+        pipe: true, // enables the esbuild's pipe mode
     });
 
     return () => {

package/src/gulp/public.ts

@@ -16,6 +16,7 @@ export function buildPublic(options: TaskOptions) {
     const { outputDir, enableIncrementalBuild } = options;
     const gulpEsbuild = createGulpEsbuild({
         incremental: enableIncrementalBuild,
+        pipe: true,
     });
 
     // Create tasks for each folder

package/src/gulp/types.ts

@@ -9,6 +9,7 @@ import merge from 'merge-stream';
 import * as insert from 'gulp-insert';
 import { blue, red, yellow } from '../index.js';
 import tap from 'gulp-tap';
+import { TSConfig } from '../models';
 
 export function updateWixTypes(options: TaskOptions) {
     return () => {
@@ -111,29 +112,29 @@ export function updateWixTypes(options: TaskOptions) {
 			count ++;
 			if (file.dirname.endsWith('public')) {
 				return stream.pipe(jeditor(publicSettings))
-						.pipe(jeditor((json: any) => cleanTsConfig(json)))
-						.pipe(jeditor((json: any) => processJson(json)))
-						.pipe(replace('"../backend.d.ts",', '', replaceOptions))
-						.pipe(replace('"../../../src/backend/\\*\\*/\\*.web.js",', '', replaceOptions));
+					.pipe(jeditor((json: any) => cleanTsConfig(json)))
+					.pipe(jeditor((json: any) => processJson(json)))
+					.pipe(replace('"../backend.d.ts",', '', replaceOptions))
+					.pipe(replace('"../../../src/backend/\\*\\*/\\*.web.js",', '', replaceOptions));
 			}
 			if (file.dirname.endsWith('backend')) {
 				return stream.pipe(jeditor(backendSettings))
-						.pipe(jeditor((json: any) => cleanTsConfig(json)))
-						.pipe(jeditor((json: any) => processJson(json)))
+					.pipe(jeditor((json: any) => cleanTsConfig(json)))
+					.pipe(jeditor((json: any) => processJson(json)))
 			};
 			if (file.dirname.endsWith('masterPage')) {
 				return stream.pipe(jeditor(masterSettings))
-						.pipe(jeditor((json: any) => cleanTsConfig(json)))
-						.pipe(jeditor((json: any) => processJson(json)))
-						.pipe(replace('"../backend.d.ts",', '', replaceOptions))
-						.pipe(replace('"../../../src/backend/\\*\\*/\\*.web.js",', '', replaceOptions));
-			};
-			
-			return stream.pipe(jeditor(pageSettings))
 					.pipe(jeditor((json: any) => cleanTsConfig(json)))
 					.pipe(jeditor((json: any) => processJson(json)))
 					.pipe(replace('"../backend.d.ts",', '', replaceOptions))
 					.pipe(replace('"../../../src/backend/\\*\\*/\\*.web.js",', '', replaceOptions));
+			};
+			
+			return stream.pipe(jeditor(pageSettings))
+				.pipe(jeditor((json: any) => cleanTsConfig(json)))
+				.pipe(jeditor((json: any) => processJson(json)))
+				.pipe(replace('"../backend.d.ts",', '', replaceOptions))
+				.pipe(replace('"../../../src/backend/\\*\\*/\\*.web.js",', '', replaceOptions));
 		}))
 		.pipe(replace('masterPage.masterPage.js', 'masterPage.ts', replaceOptions))
 		.pipe(replace('/src/', '/typescript/', replaceOptions))
@@ -259,33 +260,19 @@ function processJson(obj: any): any {
     }
 }
 
-function cleanTsConfig(json: any): any {
-    // Process the paths object to remove duplicates
-    if (json.compilerOptions?.paths) {
-        for (const key in json.compilerOptions.paths) {
-            if (Array.isArray(json.compilerOptions.paths[key])) {
-                const uniquePaths = [...new Set(json.compilerOptions.paths[key])];
-                json.compilerOptions.paths[key] = uniquePaths.length > 0 ? uniquePaths : undefined;
-            }
-        }
-    }
-
-    // Process the include array to remove duplicates
-    if (Array.isArray(json.include)) {
-        const uniqueIncludes = [...new Set(json.include)];
-        json.include = uniqueIncludes.length > 0 ? uniqueIncludes : undefined;
-    }
-
-    // Remove empty or undefined fields
-    if (json.compilerOptions?.paths) {
-        json.compilerOptions.paths = Object.fromEntries(
-            Object.entries(json.compilerOptions.paths).filter(([_, value]) => value !== undefined)
-        );
-    }
-
-    if (json.include?.length === 0) {
-        delete json.include;
-    }
+function cleanTsConfig(json: TSConfig): TSConfig {
+	// const paths: Record<string, string[]> = {};
+	if (json.compilerOptions?.paths) {
+		for (const [key, value] of Object.entries(json.compilerOptions.paths)) {
+			const uniquePaths = new Set(value);
+			json.compilerOptions.paths[key] = Array.from(uniquePaths);
+			// paths[key] = Array.from(uniquePaths);
+		}
+		// json.compilerOptions.paths = paths;
+	}
+	json.include = Array.from(new Set(json.include));
+	json.exclude = Array.from(new Set(json.exclude));
+	json.files = Array.from(new Set(json.files));
 
-    return json;
+	return json;
 }

package/src/models.ts

@@ -0,0 +1,35 @@
+export type TSConfig = {
+    compilerOptions?: {
+        target?: string; // e.g., "ES5", "ES6", "ES2015", "ESNext"
+        module?: string; // e.g., "CommonJS", "ES6", "ESNext"
+        lib?: string[]; // e.g., ["ES2015", "DOM"]
+        outDir?: string;
+        rootDir?: string;
+        strict?: boolean;
+        esModuleInterop?: boolean;
+        allowJs?: boolean;
+        checkJs?: boolean;
+        declaration?: boolean;
+        declarationMap?: boolean;
+        sourceMap?: boolean;
+        removeComments?: boolean;
+        noImplicitAny?: boolean;
+        moduleResolution?: "node" | "classic";
+        resolveJsonModule?: boolean;
+        skipLibCheck?: boolean;
+        types?: string[]; // e.g., ["node", "jest"]
+        typeRoots?: string[]; // e.g., ["./types"]
+        jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
+        incremental?: boolean;
+        noEmit?: boolean;
+        paths?: Record<string, string[]>; // Aliases for module paths
+        [key: string]: any; // Allow additional compiler options
+    };
+    include?: string[]; // Glob patterns to include
+    exclude?: string[]; // Glob patterns to exclude
+    files?: string[]; // Specific files to include
+    extends?: string; // Path to a base tsconfig.json
+    references?: { path: string }[]; // Project references
+    compileOnSave?: boolean;
+    [key: string]: any; // Allow additional top-level options
+};