lucy-cli 0.9.0 → 0.9.2

package/README.md

@@ -70,6 +70,12 @@ Lucy-CLI comes with a range of commands and options to help manage your Wix Velo
 - **`sync`**: Synchronizes the database and any dependencies or configurations necessary for the project.
 - **`install`**: Installs all Wix npm packages listed in the `wixpkgs.json` file in the project directory.
 - **`fix`**: Runs a fix command to resolve common issues in development or production settings.
+- **🦮 `docs`**: Generates documentation for the project.
+- **🦮 `cypress`**: Starts the Cypress test runner.
+- **🦮 `e2e`**: Starts the Cypress test runner in CI mode.  
+  **Usage:** `e2e <someKey> <someID>`  
+  - **`someKey`**: The key for the test.  
+  - **`someID`**: The build ID for the test.
 
 ### Options
 
@@ -114,6 +120,9 @@ Commands:
 🦮 sync               : Synchronizes the database and any dependencies or configurations necessary for the project.
 🦮 install            : Installs all Wix npm packages listed in the 'wixpkgs.json' file in the project directory.
 🦮 fix                : Runs a fix command to resolve common issues in development or production settings.
+🦮 docs               : Generates documentation for the project.
+🦮 cypress            : Starts the cypress test runner.
+🦮 e2e                : Starts the cypress test runner in CI mode. first argument is the key second is the build id <e2e <somekey <someID>
 
 Options:
 🦮 -h, help           : Displays this help message.

package/dist/gulp/checks.js

@@ -127,7 +127,7 @@ export function checkTs(options) {
         const tsProject = ts.createProject(`./${folder}/tsconfig.json`, { noEmit: true });
         const taskName = `test-${folder}`; // Create a unique name for each task
         const task = () => gulp.src([`${folder}/**/*.ts`, `!${folder}/types/**/*.ts`], { cwd: folder })
-            .pipe(tsProject(ts.reporter.fullReporter()))
+            .pipe(tsProject(ts.reporter.fullReporter(true)))
             .on('error', function (e) {
             console.log("💩" + red.underline.bold(` => Typescriptcheck for ${orange(folder)} failed!`));
             console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));

package/dist/index.js

@@ -96,6 +96,8 @@ async function main() {
         console.log("🦮 " + magenta.bold('install') + "            : Installs all Wix npm packages listed in the 'lucy.json' file in the project directory.");
         console.log("🦮 " + magenta.bold('fix') + "                : Runs a fix command to resolve common issues in development or production settings.");
         console.log("🦮 " + magenta.bold('docs') + "               : Generates documentation for the project.");
+        console.log("🦮 " + magenta.bold('cypress') + "            : Starts the cypress test runner.");
+        console.log("🦮 " + magenta.bold('e2e') + "                : Starts the cypress test runner in CI mode. first argument is the key second is the build id <e2e <somekey <someID>");
         console.log("\nOptions:");
         console.log("🦮 " + magenta.bold('-h, help') + "           : Displays this help message.");
         console.log("🦮 " + magenta.bold('-v, version') + "        : Displays the current version of Lucy CLI as defined in the project’s package.json.");
@@ -171,10 +173,35 @@ async function main() {
     if (moduleSettings.args.includes('docs')) {
         const res = spawnSync('yarn docs', { shell: true, stdio: 'inherit' });
         if (res.error) {
-            return console.log((`💩 ${red.underline.bold("=> Failed to install dev packages =>")} ${orange(res.error.message)}`));
+            return console.log((`💩 ${red.underline.bold("=> Failed to Docs generated => ")} ${orange(res.error.message)}`));
         }
         return console.log("🐕" + blue.underline(` => Docs generated!`));
     }
+    if (moduleSettings.args.includes('cypress')) {
+        const res = spawnSync('yarn cypress', { shell: true, stdio: 'inherit' });
+        if (res.error) {
+            return console.log((`💩 ${red.underline.bold("=> Failed to start cypress => ")} ${orange(res.error.message)}`));
+        }
+        return console.log("🐕" + blue.underline(` => Started Cypress`));
+    }
+    if (moduleSettings.args.includes('e2e')) {
+        // Extract arguments
+        const e2eIndex = moduleSettings.args.indexOf('e2e');
+        const key = moduleSettings.args[e2eIndex + 1];
+        const buildId = moduleSettings.args[e2eIndex + 2];
+        // Validate that both arguments are provided
+        if (!key && !buildId) {
+            console.log(`💩 ${red.underline.bold("=> Missing required arguments:")} ${orange("key")} and ${orange("build ID")}`);
+            process.exit(1);
+        }
+        // Run Cypress with the provided arguments
+        const res = spawnSync(`yarn e2e --key ${key} --ci-build-id ${buildId}`, { shell: true, stdio: 'inherit' });
+        if (res.error) {
+            console.log(`💩 ${red.underline.bold("=> Failed to start Cypress =>")} ${orange(res.error.message)}`);
+            process.exit(1);
+        }
+        return console.log("🐕 " + blue.underline(`=> Started Cypress successfully`));
+    }
     if (moduleSettings.args.includes('prepare')) {
         await prepare(moduleSettings, projectSettings);
         return;

package/dist/settings.json

@@ -57,6 +57,8 @@
         "fix-wix": "lucy-cli fix-wix",
         "tsc": "tsc -p ./typescript/tsconfig.json --noEmit",
         "test": "jest --config jest.config.ts --passWithNoTests",
-        "test:watch": "jest --config jest.config.ts --watch"
+        "test:watch": "jest --config jest.config.ts --watch",
+        "cypress": "cypress open",
+        "e2e": "cypress-cloud run --parallel --record"
     }
 }

package/files/cypress/e2e/base/base.cy.ts

@@ -0,0 +1,14 @@
+
+describe('Basic E2E Test', () => {
+	const currentDate = new Date();
+	const formattedDate = currentDate.toISOString().split('T')[0];
+	const formattedTime = currentDate.toTimeString().split(' ')[0].replace(/:/g, '-');
+	
+	it('passes', () => {
+		cy.visit('/');
+		cy.get('#comp-m3blk8zj_r_comp-m3ta27x7').should('be.visible');
+		cy.screenshot(`loaded_${formattedDate}_${formattedTime}`);
+	});
+});
+
+

package/files/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

package/files/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

package/files/cypress/support/e2e.ts

@@ -0,0 +1,24 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// before(() => {
+//     // Set the base URL for your application
+//     cy.visit('https://www.zikade.ch');
+// });
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package/files/cypress/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "lib": ["es5", "dom"],
+        "types": ["cypress", "node"],
+        "rootDir": "."
+    },
+    "include": ["**/*.ts"]
+}

package/files/cypress.config.ts

@@ -1,10 +1,22 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-require-imports */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
 // cypress.config.js
-import { defineConfig } from "cypress";
-import { cloudPlugin } from "cypress-cloud/plugin";
+const { defineConfig } = require('cypress');
+const { cloudPlugin } = require('cypress-cloud/plugin');
 
 module.exports = defineConfig({
 	videoCompression: 15,
+	chromeWebSecurity: true,
+	pageLoadTimeout: 120000,
+	defaultCommandTimeout: 10000,
+	retries: {
+		runMode: 0,
+		openMode: 0,
+	},
 	e2e: {
+		baseUrl: 'https://www.somehost.com/',
 		setupNodeEvents(on, config) {
 			return cloudPlugin(on, config);
 		},

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "lucy-cli",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Lucy Framework for WIX Studio Editor",
   "main": ".dist/index.js",
   "scripts": {
@@ -68,7 +68,8 @@
     "ts-node": "^10.9.1",
     "typedoc": "0.26.11",
     "typedoc-theme-hierarchy": "5.0.3",
-    "velo-sync": "^0.0.9"
+    "velo-sync": "^0.0.9",
+    "typescript": "^5.6.3"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
@@ -92,7 +93,6 @@
     "eslint-plugin-jsdoc": "50.5.0",
     "eslint-plugin-named-import-spacing": "^1.0.3",
     "eslint-plugin-simple-import-sort": "12.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.6.3"
+    "ts-node": "^10.9.1"
   }
 }

package/src/gulp/checks.ts

@@ -135,12 +135,13 @@ export function checkTs(options: TaskOptions) {
 
         const task = () =>
             gulp.src([`${folder}/**/*.ts`, `!${folder}/types/**/*.ts`], { cwd: folder })
-				.pipe(tsProject(ts.reporter.fullReporter()))
+				.pipe(tsProject(ts.reporter.fullReporter(true)))
                 .on('error', function (e: Error) {
                     console.log("💩" + red.underline.bold(` => Typescriptcheck for ${orange(folder)} failed!`));
 					console.log("💩" + red.underline.bold(` => Error: ${orange(e.message)}`));
                     this.emit('end');
                 })
+				
                 .on('end', function () {
                     console.log("🐶" + blue.underline(` => Typescriptcheck for ${orange(folder)} succeeded!`));
                 });

package/src/index.ts

@@ -155,6 +155,8 @@ async function main(): Promise<void> {
 		console.log("🦮 " + magenta.bold('install') + "            : Installs all Wix npm packages listed in the 'lucy.json' file in the project directory.");
 		console.log("🦮 " + magenta.bold('fix') + "                : Runs a fix command to resolve common issues in development or production settings.");
 		console.log("🦮 " + magenta.bold('docs') + "               : Generates documentation for the project.");
+		console.log("🦮 " + magenta.bold('cypress') + "            : Starts the cypress test runner.");
+		console.log("🦮 " + magenta.bold('e2e') + "                : Starts the cypress test runner in CI mode. first argument is the key second is the build id <e2e <somekey <someID>");
 		console.log("\nOptions:");
 		console.log("🦮 " + magenta.bold('-h, help') + "           : Displays this help message.");
 		console.log("🦮 " + magenta.bold('-v, version') + "        : Displays the current version of Lucy CLI as defined in the project’s package.json.");
@@ -234,11 +236,40 @@ async function main(): Promise<void> {
 	if(moduleSettings.args.includes('docs')){
 		const res = spawnSync('yarn docs', { shell: true, stdio: 'inherit' });
 		if (res.error) {
-			return console.log((`💩 ${red.underline.bold("=> Failed to install dev packages =>")} ${orange(res.error.message)}`));
+			return console.log((`💩 ${red.underline.bold("=> Failed to Docs generated => ")} ${orange(res.error.message)}`));
 		}
 		return console.log("🐕" + blue.underline(` => Docs generated!`));
 	}
 
+	if(moduleSettings.args.includes('cypress')){
+		const res = spawnSync('yarn cypress', { shell: true, stdio: 'inherit' });
+		if (res.error) {
+			return console.log((`💩 ${red.underline.bold("=> Failed to start cypress => ")} ${orange(res.error.message)}`));
+		}
+		return console.log("🐕" + blue.underline(` => Started Cypress`));
+	}
+
+	if (moduleSettings.args.includes('e2e')) {
+		// Extract arguments
+		const e2eIndex = moduleSettings.args.indexOf('e2e');
+		const key = moduleSettings.args[e2eIndex + 1];
+		const buildId = moduleSettings.args[e2eIndex + 2];
+	
+		// Validate that both arguments are provided
+		if (!key && !buildId) {
+			console.log(`💩 ${red.underline.bold("=> Missing required arguments:")} ${orange("key")} and ${orange("build ID")}`);
+			process.exit(1);
+		}
+	
+		// Run Cypress with the provided arguments
+		const res = spawnSync(`yarn e2e --key ${key} --ci-build-id ${buildId}`, { shell: true, stdio: 'inherit' });
+		if (res.error) {
+			console.log(`💩 ${red.underline.bold("=> Failed to start Cypress =>")} ${orange(res.error.message)}`);
+			process.exit(1);
+		}
+		return console.log("🐕 " + blue.underline(`=> Started Cypress successfully`));
+	}
+
 	if(moduleSettings.args.includes('prepare')){
 		await prepare( moduleSettings, projectSettings);
 

package/src/settings.json

@@ -57,6 +57,8 @@
     "fix-wix": "lucy-cli fix-wix",
     "tsc": "tsc -p ./typescript/tsconfig.json --noEmit",
     "test": "jest --config jest.config.ts --passWithNoTests",
-    "test:watch": "jest --config jest.config.ts --watch"
+    "test:watch": "jest --config jest.config.ts --watch",
+    "cypress": "cypress open",
+    "e2e": "cypress-cloud run --parallel --record"
   }
 }