lucy-cli 0.9.5 → 0.9.6

package/README.md

@@ -44,10 +44,12 @@ Lucy-CLI is designed to streamline the setup and management of TypeScript within
 8. **Wix NPM Package Installation**
    - Lucy-CLI can install Wix npm packages from the `lucy.json` file in the project directory.
 
-9. **Teting with Vitest(Not working)**
-   - Lucy-CLI can run tests with Jest.
+9. **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**
     - Lucy-CLI can lint the code with ESLint.

package/dist/Gulpfile.js

@@ -18,7 +18,7 @@ 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 { green, magenta, orange, red } from './index.js';
+import { blue, green, magenta, orange, red } from './index.js';
 import { getModulesSync } from './gulp/helpers.js';
 const sass = gulpSass(dartSass);
 const outputDir = './src';
@@ -47,11 +47,13 @@ gulp.task('build-backend', gulp.parallel(buildBackend(taskOptions), buildBackend
 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', gulp.parallel(
-// test(taskOptions),
-shell.task([
-    'sleep 2; yarn test',
-])));
+gulp.task('test', function () {
+    return shell.task(['yarn test'], { ignoreErrors: true })().then(() => {
+        console.log("🐕" + blue.underline.bold(' => Exited test task!'));
+    }).catch(err => {
+        console.log("💩" + red.underline.bold(' => Error in test task!'));
+    });
+});
 gulp.task('sync-types', shell.task([
     'yarn postinstall',
 ]));
@@ -61,7 +63,7 @@ gulp.task('add-wix-types', function (done) {
 });
 gulp.task('set-production', gulp.parallel(setProdConfig()));
 gulp.task('start-wix', shell.task([
-    'yarn wix:dev',
+    'sleep 3; yarn wix:dev',
 ]));
 gulp.task('gen-docs', shell.task([
     'yarn docs',
@@ -72,9 +74,7 @@ gulp.task('build-pipeline', gulp.series(cleanSrc(taskOptions), 'set-production',
 // 'test',
 'build'));
 gulp.task('build-prod', gulp.series((done) => checkPages(true, false).then(() => done(), (err) => done(err)), cleanSrc(taskOptions), 'set-production', 'fix-wix', 'build-backend', 'build-public', buildPages(taskOptions), 'copy-files', compileScss(taskOptions), 'gen-docs'));
-gulp.task('start-dev-env', gulp.parallel(watchAll(taskOptions), 
-// 'test',
-'start-wix', (done) => checkPages(false, taskOptions.moduleSettings?.force ?? false).then(() => done(), (err) => done(err))));
+gulp.task('start-dev-env', gulp.parallel(watchAll(taskOptions), 'test', 'start-wix', (done) => checkPages(false, taskOptions.moduleSettings?.force ?? false).then(() => done(), (err) => done(err))));
 gulp.task('dev', gulp.series(cleanSrc(taskOptions), 'fix-wix', 'build', 'start-dev-env'));
 async function gulpTaskRunner(task) {
     return new Promise(function (resolve, reject) {

package/dist/gulp/templates.js

@@ -19,7 +19,7 @@ export function previewTemplates(options) {
             `${folder}/backend/templates/data/*.json`,
             `!${folder}/backend/templates/render.ts`,
         ])
-            .pipe(exec((file) => `npx tsx --tsconfig ${file.dirname}/../../local.tsconfig.json ${file.path}`, taskOpt))
+            .pipe(exec((file) => `npx tsx --tsconfig ./local.tsconfig.json ${file.path}`, taskOpt))
             .on('error', function (e) {
             console.log("💩" + red.underline.bold(` => Render of Template for ${orange(folder)} failed!`));
             console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));

package/dist/gulp/test.d.ts

@@ -1,2 +1,2 @@
 import { TaskOptions } from '../Gulpfile.js';
-export declare function test(options: TaskOptions): import("undertaker").TaskFunction;
+export declare function buildPages(options: TaskOptions): () => any;

package/dist/gulp/test.js

@@ -5,75 +5,22 @@ const jest = gulpJest.default;
 const taskOpt = {
     continueOnError: true,
 };
-export function test(options) {
-    const folders = ['typescript'];
-    // if (options.modulesSync){
-    //     for (const module of Object.keys(options.modulesSync)) {
-    //         folders.push(module);
-    //     }
-    // }
-    // Create tasks for each folder
-    const tasks = folders.map((folder) => {
-        const taskName = `tests-coverage-${folder}`; // Create a unique name for each task
-        const task = () => gulp.src([
-            `${folder}/backend/**/*.spec.ts`,
-        ])
-            .pipe(exec((file) => `yarn coverage`, taskOpt))
+export function buildPages(options) {
+    const { outputDir } = options;
+    return () => {
+        return gulp.src('typescript/pages/*.ts')
+            .pipe(swc(swcOptions))
             .on('error', function (e) {
-            console.log("💩" + red.underline.bold(` => Failed to generate coverage for ${orange(folder)} failed!`));
+            console.log("💩" + red.underline.bold(` => Build of Pages files failed!`));
             console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
             this.emit('end');
         })
-            .on('end', function () {
-            console.log("🐶" + blue.underline(` => Coverage 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);
-    // return () => {
-    //     return gulp.src([
-    //         ...folders.map(folder => `${folder}/backend/**/*.spec.ts`)
-    //         ])
-    //         .pipe(jest({
-    //             verbose: true,
-    //             extensionsToTreatAsEsm: ['.ts'],
-    //             transform: {
-    //                 '^.+\\.tsx?$': [
-    //                     'ts-jest',
-    //                     {
-    //                         tsconfig: `./typescript/tsconfig.json`,
-    //                         usESM: true,
-    //                     },
-    //                 ],
-    //             },
-    //             preset: 'ts-jest',
-    //             setupFilesAfterEnv: [],
-    //             testEnvironment: 'node',
-    //             collectCoverage: true,
-    //             coverageDirectory: './coverage',
-    //             coverageReporters: ['clover', 'json', 'lcov', 'text'],
-    //             rootDir: `./typescript`,
-    //             roots: [`.`],
-    //             testMatch: ['**/*.spec.ts'],
-    //             passWithNoTests: true,
-    //             moduleNameMapper: {
-    //                 'public/(.*)': [...folders.map(folder => `${folder}/$1`)],
-    //                 'backend/(.*)': [...folders.map(folder => `${folder}/$1`)],
-    //             }
-    //         }))
-    //             .on('error', function (e: Error) {
-    //                 console.log("💩" + red.underline.bold(` => Tests for failed!`));
-    //                 console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-    //                 this.emit('end');
-    //             })
-    //             .on('end', function () {
-    //                 console.log("🐶" + blue.underline(` => Tests succeeded!`));
-    //             });
-    // }
-}
-function exec(arg0, taskOpt) {
-    throw new Error('Function not implemented.');
+            .pipe(gulp.dest(path.join(outputDir, 'pages')))
+            .on('error', function (e) {
+            console.log("💩" + red.underline.bold(' => Build of Pages TS files failed!'));
+            console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
+            this.emit('end');
+        })
+            .on('end', function () { console.log("🐶" + blue.underline(' => Build of Pages TS files succeeded!')); });
+    };
 }

package/dist/gulp/watchers.js

@@ -6,6 +6,7 @@ import { buildPages } from './pages.js';
 import { copyFiles } from './copy.js';
 import { previewTemplates } from './templates.js';
 import { checkTs } from './checks.js';
+import shell from 'gulp-shell';
 let taskOptions;
 export function watchSCSS() {
     return gulp.watch([
@@ -18,13 +19,17 @@ export function watchBackend() {
         '*/backend/**/*.tsx',
         '!*/backend/**/*.jsw.ts',
         '!src/**/**',
-    ], gulp.parallel(checkTs(taskOptions), buildBackend(taskOptions)));
+    ], gulp.parallel(checkTs(taskOptions), buildBackend(taskOptions), shell.task([
+        'yarn docs',
+    ])));
 }
 export function watchPublic() {
     return gulp.watch([
         '*/public/**/*.ts',
         '*/public/**/*.tsx',
-    ], gulp.parallel(checkTs(taskOptions), buildPublic(taskOptions)));
+    ], gulp.parallel(checkTs(taskOptions), buildPublic(taskOptions), shell.task([
+        'yarn docs',
+    ])));
 }
 export function watchPages() {
     return gulp.watch('typescript/pages/**/*.ts', gulp.parallel(checkTs(taskOptions), buildPages(taskOptions)));

package/dist/settings.json

@@ -41,9 +41,6 @@
         "ts-node": "^10.9.2",
         "tsx": "^4.19.2",
         "typedoc": "0.27.1",
-        "typedoc-plugin-merge-modules": "^6.0.3",
-        "typedoc-plugin-zod": "^1.3.0",
-        "typedoc-theme-hierarchy": "^5.0.3",
         "typescript": "5.6.3",
         "typescript-eslint": "^8.15.0",
         "typescript-eslint-language-service": "^5.0.5",
@@ -60,7 +57,7 @@
         "build": "lucy-cli build-prod",
         "fix-wix": "lucy-cli fix-wix",
         "tsc": "tsc -p ./typescript/tsconfig.json --noEmit",
-        "test": "vitest --ui",
+        "test": "vitest --ui --coverage",
         "coverage": "vitest run --coverage",
         "cypress": "cypress open",
         "e2e": "cypress-cloud run --parallel --record"

package/files/local.tsconfig.json

@@ -0,0 +1,53 @@
+{
+  "typeAcquisition": {
+    "enable": true
+  },
+  "compilerOptions": {
+    "outDir": "../src",
+    "rootDir": ".",
+    "target": "ES2020",
+    "module": "ES2020",
+    "moduleResolution": "Node",
+    "preserveConstEnums": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": false,
+    "allowJs": true,
+    "declaration": true,
+    "jsx": "react",
+    "strict": true,
+    "alwaysStrict": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "exactOptionalPropertyTypes": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "strictPropertyInitialization": true,
+    "resolveJsonModule": true,
+    "plugins": [
+      {
+        "name": "@styled/typescript-styled-plugin"
+      },
+      {
+        "name": "typescript-eslint-language-service"
+      }
+    ],
+    "paths": {
+      "public/*": ["./lib/public/*", "./typescript/public/*"],
+      "backend/*": ["./lib/backend/*", "./typescript/backend/*"],
+      "pages/*": ["./pages/*"],
+      "types/*": ["./types/*"]
+    },
+    "typeRoots": ["./types", "../node_modules/@types"]
+  },
+  "exclude": [
+    "../node_modules",
+    "../.wix",
+    "node_modules",
+    "./wix",
+    "./**/*.test.ts",
+    "../src/**/*"
+  ],
+  "include": ["!*.d.ts", "public/**/*.tsx", "**/*.ts"]
+}

package/files/typedoc.json

@@ -7,23 +7,22 @@
   "entryPointStrategy": "expand",
   "out": "docs",
   "plugin": [
-    "typedoc-theme-hierarchy",
-    "typedoc-plugin-zod",
-    "typedoc-plugin-merge-modules"
+    "typedoc-github-theme",
   ],
-  "theme": "hierarchy",
-  "tsconfig": "docs.tsconfig.json",
+  "tsconfig": "local.tsconfig.json",
   "excludeExternals": true,
   "externalPattern": [
     "**/node_modules/**",
     "**/.wix/**",
-    ".wix/**"
+    ".wix/**",
   ],
   "exclude": [
     "./.wix/**/*",
-    ".wix/**/*"
+    ".wix/**/*",
+    "cypress/**",
+    "**/__mocks__/**",
   ],
-  "name": "Wix-lucy",
-  "mergeModulesRenameDefaults": true, 
-  "mergeModulesMergeMode": "project",
+  "name": "wix-integraleakademie",
+  // "mergeModulesRenameDefaults": false, // NEW option of TypeDoc added by this plugin
+  // "mergeModulesMergeMode": "project", // NEW option of TypeDoc added by this plugin
 }

package/files/vitest.config.ts

@@ -1,17 +1,57 @@
-// eslint-disable-next-line @typescript-eslint/naming-convention
+/* eslint-disable @typescript-eslint/naming-convention */
+import path from 'node:path';
+
+import fs from 'fs';
 import tsconfigPaths from 'vite-tsconfig-paths';
 import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
-	plugins: [tsconfigPaths({
-		projects: ['./typescript/tsconfig.json'],
-	})],
+	plugins: [
+		tsconfigPaths({
+			projects: ['./local.tsconfig.json'],
+		}),
+		{
+			name: 'multi-folder-wix-resolution',
+			enforce: 'pre',
+			resolveId(source) {
+
+				if (source.startsWith('wix')){
+					const baseName = source.replace(/^wix/, '');
+					const candidates = [
+						path.resolve(__dirname, './lib/__mocks__/wix' + baseName),
+						path.resolve(__dirname, './typescript/__mocks__/wix' + baseName),
+					];
+
+					for (const candidate of candidates){
+						if (fs.existsSync(candidate + '.ts') || fs.existsSync(candidate + '/index.ts')){
+							return candidate;
+						}
+					}
+				}
+
+				return null;
+			},
+		},
+	],
 	test: {
 		coverage: {
 			provider: 'v8',
 			reporter: ['text', 'json', 'html'],
 			reportsDirectory: './coverage',
-			exclude: ['**/node_modules/**', 'src/**', '.wix/**'],
+			exclude: ['**/node_modules/**', 'src/**', '.wix/**', '**/models/**', '**/__mocks__/**', 'docs/**', 'cypress/**', '**/pages/**'],
 		},
+		alias: {}
 	},
+	// resolve: {
+	// 	alias: [
+	// 		{
+	// 			find: /^wix(.*)$/,
+	// 			replacement: path.resolve(__dirname, './lib/__mocks__/wix$1'),
+	// 		},
+	// 		{
+	// 			find: /^wix(.*)$/,
+	// 			replacement: path.resolve(__dirname, './typescript/__mocks__/wix$1'),
+	// 		},
+	// 	],
+	// },
 });

package/package.json

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

package/src/Gulpfile.ts

@@ -20,8 +20,7 @@ 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 { ModuleSettings, ProjectSettings, green, magenta, orange, red } from './index.js';
-import { test } from './gulp/test.js';
+import { ModuleSettings, ProjectSettings, blue, green, magenta, orange, red } from './index.js';
 import { getModulesSync } from './gulp/helpers.js';
 
 const sass = gulpSass(dartSass);
@@ -95,13 +94,16 @@ gulp.task('copy-files', gulp.parallel(
 	copyFiles(taskOptions),
 ));
 
-gulp.task('test', gulp.parallel(
-	// test(taskOptions),
-	shell.task([
-		'sleep 2; yarn test',
-	])
-));
-
+gulp.task('test', function () {
+	return shell.task(
+		['yarn test'],
+		{ ignoreErrors: true }
+	)().then(() => {
+		console.log("🐕" + blue.underline.bold(' => Exited test task!'));
+	}).catch(err => {
+		console.log("💩" + red.underline.bold(' => Error in test task!'));
+	});
+});
 
 gulp.task('sync-types', shell.task([
 	'yarn postinstall',
@@ -120,7 +122,7 @@ gulp.task('set-production', gulp.parallel(
 ));
 
 gulp.task('start-wix', shell.task([
-	'yarn wix:dev',
+	'sleep 3; yarn wix:dev',
 ]));
 
 gulp.task('gen-docs', shell.task([
@@ -169,7 +171,7 @@ gulp.task('build-prod', gulp.series(
 
 gulp.task('start-dev-env', gulp.parallel(
 	watchAll(taskOptions),
-	// 'test',
+	'test',
 	'start-wix',
 	(done) => checkPages(false, taskOptions.moduleSettings?.force ?? false).then(() => done(), (err) => done(err)),
 ));

package/src/gulp/templates.ts

@@ -24,7 +24,7 @@ export function previewTemplates(options: TaskOptions) {
                     `${folder}/backend/templates/data/*.json`, 
                     `!${folder}/backend/templates/render.ts`,
                 ])
-                .pipe(exec((file: File) => `npx tsx --tsconfig ${file.dirname}/../../local.tsconfig.json ${file.path}`, taskOpt))
+                .pipe(exec((file: File) => `npx tsx --tsconfig ./local.tsconfig.json ${file.path}`, taskOpt))
                     .on('error', function (e: Error) {
                         console.log("💩" + red.underline.bold(` => Render of Template for ${orange(folder)} failed!`));
                         console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));

package/src/gulp/watchers.ts

@@ -7,7 +7,6 @@ import { buildPages } from './pages.js';
 import { copyFiles } from './copy.js';
 import { previewTemplates } from './templates.js';
 import { checkPages, checkTs } from './checks.js';
-import { test } from './test.js';
 import shell from 'gulp-shell';
 
 let taskOptions: TaskOptions;
@@ -29,7 +28,9 @@ export function watchBackend() {
 	], gulp.parallel(
         checkTs(taskOptions),
         buildBackend(taskOptions),
-        )
+        shell.task([
+            'yarn docs',
+        ]))
     );
 }
 
@@ -40,7 +41,9 @@ export function watchPublic() {
 	], gulp.parallel(
         checkTs(taskOptions),
         buildPublic(taskOptions),
-        )
+        shell.task([
+            'yarn docs',
+        ]))
     );
 }
 

package/src/settings.json

@@ -41,9 +41,6 @@
     "ts-node": "^10.9.2",
     "tsx": "^4.19.2",
     "typedoc": "0.27.1",
-    "typedoc-plugin-merge-modules": "^6.0.3",
-    "typedoc-plugin-zod": "^1.3.0",
-    "typedoc-theme-hierarchy": "^5.0.3",
     "typescript": "5.6.3",
     "typescript-eslint": "^8.15.0",
     "typescript-eslint-language-service": "^5.0.5",
@@ -60,7 +57,7 @@
     "build": "lucy-cli build-prod",
     "fix-wix": "lucy-cli fix-wix",
     "tsc": "tsc -p ./typescript/tsconfig.json --noEmit",
-    "test": "vitest --ui",
+    "test": "vitest --ui --coverage",
     "coverage": "vitest run --coverage",
     "cypress": "cypress open",
     "e2e": "cypress-cloud run --parallel --record"

package/src/gulp/test.ts

@@ -1,87 +0,0 @@
-import gulp from 'gulp';
-import { blue, orange, red } from '../index.js';
-import gulpJest from 'gulp-jest';
-import { TaskOptions } from '../Gulpfile.js';
-const jest = gulpJest.default;
-
-const taskOpt = {
-    continueOnError: true,
-};
-export function test(options: TaskOptions) {
-    const folders = ['typescript'];
-    // if (options.modulesSync){
-    //     for (const module of Object.keys(options.modulesSync)) {
-    //         folders.push(module);
-    //     }
-    // }
-    
-    // Create tasks for each folder
-    const tasks = folders.map((folder) => {
-        const taskName = `tests-coverage-${folder}`; // Create a unique name for each task
-        const task = () =>
-            gulp.src([
-                `${folder}/backend/**/*.spec.ts`,
-            ])
-            .pipe(exec((file: File) => `yarn coverage`, taskOpt))
-                .on('error', function (e: Error) {
-                    console.log("💩" + red.underline.bold(` => Failed to generate coverage for ${orange(folder)} failed!`));
-                    console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-                    this.emit('end');
-                })
-                .on('end', function () {
-                    console.log("🐶" + blue.underline(` => Coverage 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);
-
-    // return () => {
-    //     return gulp.src([
-    //         ...folders.map(folder => `${folder}/backend/**/*.spec.ts`)
-    //         ])
-    //         .pipe(jest({
-    //             verbose: true,
-    //             extensionsToTreatAsEsm: ['.ts'],
-    //             transform: {
-    //                 '^.+\\.tsx?$': [
-    //                     'ts-jest',
-    //                     {
-    //                         tsconfig: `./typescript/tsconfig.json`,
-    //                         usESM: true,
-    //                     },
-    //                 ],
-    //             },
-    //             preset: 'ts-jest',
-    //             setupFilesAfterEnv: [],
-    //             testEnvironment: 'node',
-    //             collectCoverage: true,
-    //             coverageDirectory: './coverage',
-    //             coverageReporters: ['clover', 'json', 'lcov', 'text'],
-    //             rootDir: `./typescript`,
-    //             roots: [`.`],
-    //             testMatch: ['**/*.spec.ts'],
-    //             passWithNoTests: true,
-    //             moduleNameMapper: {
-    //                 'public/(.*)': [...folders.map(folder => `${folder}/$1`)],
-    //                 'backend/(.*)': [...folders.map(folder => `${folder}/$1`)],
-    //             }
-    //         }))
-    //             .on('error', function (e: Error) {
-    //                 console.log("💩" + red.underline.bold(` => Tests for failed!`));
-    //                 console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
-    //                 this.emit('end');
-    //             })
-    //             .on('end', function () {
-    //                 console.log("🐶" + blue.underline(` => Tests succeeded!`));
-    //             });
-    // }
-}
-
-function exec(arg0: (file: File) => string, taskOpt: { continueOnError: boolean; }): any {
-    throw new Error('Function not implemented.');
-}