dceky 1.0.0-beta.6 → 1.0.3

package/lib/start/helpers/validateBrowsers.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+var AVAILABLE_BROWSERS_1 = __importDefault(require("../constants/AVAILABLE_BROWSERS"));
+/**
+ * Validate browsers (supports multiple)
+ * @author Yuen Ler Chow
+ * @param browserNames array of browser names to validate
+ * @returns array of valid browser names (lowercased)
+ */
+var validateBrowsers = function (browserNames) {
+    var valid = [];
+    var invalid = [];
+    // Convert all browser names to lowercase for comparison
+    var lowercaseBrowserNames = browserNames.map(function (browser) { return browser.toLowerCase(); });
+    // Validate each browser
+    lowercaseBrowserNames.forEach(function (browser) {
+        if (AVAILABLE_BROWSERS_1.default.some(function (b) { return b.name.toLowerCase() === browser.toLowerCase(); })) {
+            valid.push(browser);
+        }
+        else {
+            invalid.push(browser);
+        }
+    });
+    // If there are invalid browsers, log error and exit
+    if (invalid.length > 0) {
+        console.error("Browser(s) invalid: ".concat(invalid.join(', '), ". Available browsers: ").concat(AVAILABLE_BROWSERS_1.default.join(', ')));
+        process.exit(1);
+    }
+    return valid;
+};
+exports.default = validateBrowsers;
+//# sourceMappingURL=validateBrowsers.js.map

package/lib/start/helpers/validateBrowsers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateBrowsers.js","sourceRoot":"","sources":["../../../start/helpers/validateBrowsers.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,uFAAiE;AAEjE;;;;;GAKG;AACH,IAAM,gBAAgB,GAAG,UAAC,YAAsB;IAC9C,IAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,wDAAwD;IACxD,IAAM,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,OAAO,IAAO,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,wBAAwB;IACxB,qBAAqB,CAAC,OAAO,CAAC,UAAC,OAAO;QACpC,IAAI,4BAAkB,CAAC,IAAI,CAAC,UAAC,CAAC,IAAO,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/F,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,oDAAoD;IACpD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,8BAAuB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAyB,4BAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAC,CAAC;QACjH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/lib/start/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks arguments and environment variables (for PROFILE, BROWSER, and HEADLESS),
+ * asks user for missing selections, and launches Cypress
+ * @author Gardenia Liu
+ * @author Yuen Ler Chow
+ */
+export {};

package/lib/start/index.js

@@ -0,0 +1,140 @@
+"use strict";
+/* eslint-disable no-console */
+/**
+ * Checks arguments and environment variables (for PROFILE, BROWSER, and HEADLESS),
+ * asks user for missing selections, and launches Cypress
+ * @author Gardenia Liu
+ * @author Yuen Ler Chow
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import libs
+var fs_1 = __importDefault(require("fs"));
+var path_1 = __importDefault(require("path"));
+// Import helpers
+var showChooser_1 = __importDefault(require("./helpers/showChooser"));
+var parseCommaSeparated_1 = __importDefault(require("./helpers/parseCommaSeparated"));
+var findProfilesByNames_1 = __importDefault(require("./helpers/findProfilesByNames"));
+var validateBrowsers_1 = __importDefault(require("./helpers/validateBrowsers"));
+var extractArgValue_1 = __importDefault(require("./helpers/extractArgValue"));
+var getRootPath_1 = __importDefault(require("./helpers/getRootPath"));
+// Import constants
+var AVAILABLE_BROWSERS_1 = __importDefault(require("./constants/AVAILABLE_BROWSERS"));
+// Get the project directory
+var pwd = (0, getRootPath_1.default)();
+// Find available profiles under /cypress/profiles
+var profilesDir = path_1.default.join(pwd, 'cypress/profiles');
+if (!fs_1.default.existsSync(profilesDir)) {
+    console.warn("[cypress.config] Could not load profile '".concat(profilesDir, "'"));
+    process.exit(1);
+}
+// Find all files matching the pattern: {ProfileName}.Profile.ts
+var profileFiles = (fs_1.default
+    .readdirSync(profilesDir)
+    .filter(function (f) {
+    return f.endsWith('.Profile.ts');
+}));
+// Get profile names by removing '.Profile.ts'
+var profiles = profileFiles.map(function (file) {
+    var profileName = file.replace('.Profile.ts', '');
+    return { file: file, profileName: profileName };
+});
+// Exit if no profiles found
+if (profiles.length === 0) {
+    console.error("No profiles found in '".concat(profilesDir, "'"));
+    process.exit(1);
+}
+// Parse CLI arguments
+var args = process.argv.slice(2);
+// Get selections from environment variables or CLI arguments
+var selectedProfiles = [];
+var selectedBrowsers = [];
+var isHeadless = false;
+// Check for PROFILE (env var or CLI arg)
+var envProfileRaw = process.env.PROFILE;
+var argProfileRaw = (0, extractArgValue_1.default)(args, '--profile');
+var profileRaw = envProfileRaw || argProfileRaw;
+if (profileRaw) {
+    var profileNames = (0, parseCommaSeparated_1.default)(profileRaw);
+    selectedProfiles = (0, findProfilesByNames_1.default)(profileNames, profiles);
+}
+// Check for BROWSER (env var or CLI arg)
+var envBrowserRaw = process.env.BROWSER;
+var argBrowserRaw = (0, extractArgValue_1.default)(args, '--browser');
+var browserRaw = envBrowserRaw || argBrowserRaw;
+if (browserRaw) {
+    var browserNames = (0, parseCommaSeparated_1.default)(browserRaw);
+    selectedBrowsers = (0, validateBrowsers_1.default)(browserNames);
+}
+// Check for HEADLESS (env var or CLI flag)
+var envHeadlessRaw = process.env.HEADLESS;
+var headlessFlagValue = (0, extractArgValue_1.default)(args, '--headless');
+var hasHeadlessFlag = headlessFlagValue !== undefined;
+isHeadless = !!(envHeadlessRaw && envHeadlessRaw.toLowerCase() !== 'false') || hasHeadlessFlag;
+// If headless wasn't specified, ask the user to choose
+if (!envHeadlessRaw && !hasHeadlessFlag) {
+    var choices = (0, showChooser_1.default)({
+        question: 'Run in headless mode?',
+        options: [
+            { tag: '1', description: 'Yes (headless)' },
+            { tag: '2', description: 'No (interactive)' },
+        ],
+        title: 'Select mode',
+        allowMulti: false,
+    });
+    isHeadless = choices[0].tag === '1';
+}
+// If running headless and no browsers were selected, ask the user to choose
+if (isHeadless && selectedBrowsers.length === 0) {
+    var options = AVAILABLE_BROWSERS_1.default.map(function (_a) {
+        var tag = _a.tag, name = _a.name;
+        return {
+            tag: tag,
+            description: name,
+        };
+    });
+    var choices = (0, showChooser_1.default)({
+        question: 'Choose browser(s) (commas for multiple: C,F)',
+        options: options,
+        title: 'Select browser(s)',
+        allowMulti: true,
+    });
+    selectedBrowsers = (choices
+        .map(function (choice) {
+        return AVAILABLE_BROWSERS_1.default[choice.index];
+    })
+        .map(function (_a) {
+        var name = _a.name;
+        return name;
+    }));
+}
+// If no profiles were selected, ask the user to choose
+// - In headless mode, allow selecting multiple profiles
+// - In visible mode, only allow selecting a single profile
+// In the case where their environment selected more than one profile, but they are not headless, make them re-choose
+if (selectedProfiles.length === 0
+    || (!isHeadless && selectedProfiles.length > 1)) {
+    var options = profiles.map(function (p, idx) {
+        return {
+            tag: String(idx + 1),
+            description: p.profileName,
+        };
+    });
+    var choices = (0, showChooser_1.default)({
+        question: (isHeadless
+            ? 'Choose profile(s) (commas for multiple: 1,2):'
+            : 'Choose profile:'),
+        options: options,
+        title: "Choose profile".concat(isHeadless ? 's' : ''),
+        allowMulti: isHeadless,
+    });
+    selectedProfiles = choices.map(function (choice) { return profiles[choice.index]; });
+}
+// Execute commands for each combination of profile and browser (not yet implemented)
+console.log('Starting Cypress with the following configuration:');
+console.log("Profiles: ".concat(selectedProfiles.map(function (p) { return p.profileName; }).join(', ')));
+console.log("Browsers: ".concat(selectedBrowsers.join(', ')));
+console.log("Headless: ".concat(isHeadless));
+//# sourceMappingURL=index.js.map

package/lib/start/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../start/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B;;;;;GAKG;;;;;AAEH,cAAc;AACd,0CAAoB;AACpB,8CAAwB;AAExB,iBAAiB;AACjB,sEAAgD;AAChD,sFAAgE;AAChE,sFAAgE;AAChE,gFAA0D;AAC1D,8EAAwD;AACxD,sEAAgD;AAEhD,mBAAmB;AACnB,sFAAgE;AAEhE,4BAA4B;AAC5B,IAAM,GAAG,GAAG,IAAA,qBAAW,GAAE,CAAC;AAE1B,kDAAkD;AAClD,IAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;AACvD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;IAChC,OAAO,CAAC,IAAI,CAAC,mDAA4C,WAAW,MAAG,CAAC,CAAC;IACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,gEAAgE;AAChE,IAAM,YAAY,GAAG,CACnB,YAAE;KACC,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,UAAC,CAAC;IACR,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;AACnC,CAAC,CAAC,CACL,CAAC;AAEF,8CAA8C;AAC9C,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,IAAI;IACrC,IAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpD,OAAO,EAAE,IAAI,MAAA,EAAE,WAAW,aAAA,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,4BAA4B;AAC5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAC,gCAAyB,WAAW,MAAG,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,sBAAsB;AACtB,IAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,6DAA6D;AAC7D,IAAI,gBAAgB,GAA4C,EAAE,CAAC;AACnE,IAAI,gBAAgB,GAAa,EAAE,CAAC;AACpC,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,6BAAmB,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AACjE,CAAC;AAED,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,0BAAgB,EAAC,YAAY,CAAC,CAAC;AACpD,CAAC;AAED,2CAA2C;AAC3C,IAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC5C,IAAM,iBAAiB,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC9D,IAAM,eAAe,GAAG,iBAAiB,KAAK,SAAS,CAAC;AACxD,UAAU,GAAG,CAAC,CAAC,CAAC,cAAc,IAAI,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,IAAI,eAAe,CAAC;AAE/F,uDAAuD;AACvD,IAAI,CAAC,cAAc,IAAI,CAAC,eAAe,EAAE,CAAC;IACxC,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE;YACP,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;YAC3C,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;SAC9C;QACD,KAAK,EAAE,aAAa;QACpB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;AACtC,CAAC;AAED,4EAA4E;AAC5E,IAAI,UAAU,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAChD,IAAM,OAAO,GAAG,4BAAkB,CAAC,GAAG,CAAC,UAAC,EAAa;YAAX,GAAG,SAAA,EAAE,IAAI,UAAA;QACjD,OAAO;YACL,GAAG,KAAA;YACH,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,8CAA8C;QACxD,OAAO,SAAA;QACP,KAAK,EAAE,mBAAmB;QAC1B,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,gBAAgB,GAAG,CACjB,OAAO;SACJ,GAAG,CAAC,UAAC,MAAM;QACV,OAAO,4BAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC,CAAC;SACD,GAAG,CAAC,UAAC,EAAQ;YAAN,IAAI,UAAA;QACV,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACL,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,wDAAwD;AACxD,2DAA2D;AAC3D,qHAAqH;AACrH,IACE,gBAAgB,CAAC,MAAM,KAAK,CAAC;OAC1B,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,EAC/C,CAAC;IACD,IAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,GAAG;QAClC,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;YACpB,WAAW,EAAE,CAAC,CAAC,WAAW;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,CACR,UAAU;YACR,CAAC,CAAC,+CAA+C;YACjD,CAAC,CAAC,iBAAiB,CACtB;QACD,OAAO,SAAA;QACP,KAAK,EAAE,wBAAiB,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE;QAC/C,UAAU,EAAE,UAAU;KACvB,CAAC,CAAC;IAEH,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM,IAAO,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,qFAAqF;AACrF,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;AAClE,OAAO,CAAC,GAAG,CAAC,oBAAa,gBAAgB,CAAC,GAAG,CAAC,UAAC,CAAC,IAAO,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAC,CAAC;AAC9F,OAAO,CAAC,GAAG,CAAC,oBAAa,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,oBAAa,UAAU,CAAE,CAAC,CAAC"}

package/lib/start/types/ChooserOption.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An option that can be put into a chooser
+ * @author Gabe Abrams
+ */
+type ChooserOption = {
+    description: string;
+    tag?: string;
+    index?: number;
+};
+export default ChooserOption;

package/lib/start/types/ChooserOption.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ChooserOption.js.map

package/lib/start/types/ChooserOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChooserOption.js","sourceRoot":"","sources":["../../../start/types/ChooserOption.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "dceky",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.3",
   "description": "Cypress toolkit for Harvard DCE",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./lib/src/index.js",
+  "types": "./lib/src/index.d.ts",
   "scripts": {
-    "build": "tsc --project ./tsconfig.json"
+    "build": "tsc --project ./tsconfig.json",
+    "ky:start": "npx tsx ./start/index.ts",
+    "ky:setup": "npx tsx ./setup/index.ts",
+    "ky:dev": "npm run ky:setup && npm run ky:start"
   },
   "repository": {
     "type": "git",
@@ -22,11 +25,28 @@
     "url": "https://github.com/harvard-edtech/dceky/issues"
   },
   "homepage": "https://github.com/harvard-edtech/dceky#readme",
-  "peerDependencies": {
-    "cypress": "x.x.x"
+  "dependencies": {
+    "child_process": "^1.0.2",
+    "clear": "^0.1.0",
+    "deepmerge": "4.3.1",
+    "prompt-sync": "^4.2.0",
+    "@types/prompt-sync": "^4.2.3",
+    "@types/clear": "^0.1.4",
+    "@types/node": "^22.7.0"
   },
   "devDependencies": {
-    "@types/node": "^22.7.0",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "@types/deepmerge": "2.1.0",
+    "@types/node": "^24.6.1",
+    "cross-env": "^10.1.0",
+    "eslint": "^8.42.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.5"
+  },
+  "peerDependencies": {
+    "cypress": "^x.x.x"
   }
 }

package/setup/addToGitIgnore.ts

@@ -0,0 +1,48 @@
+/* eslint-disable no-console */
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import path from 'path';
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Ensure gitignore includes the necessary entries for Cypress results
+ * @author Yuen Ler Chow
+ */
+const addToGitIgnore = (): void => {
+  const root = getRootPath();
+
+  const gitignorePath = path.join(root, '.gitignore');
+
+  const entries = [
+    'cypress-results/',
+    'cypress/downloads',
+    'cypress/screenshots',
+    'cypress/videos',
+  ];
+
+  let gitignoreContent = '';
+  if (existsSync(gitignorePath)) {
+    gitignoreContent = readFileSync(gitignorePath, 'utf8');
+  }
+
+  // Check which entries are missing
+  const missingEntries = entries.filter((entry) => {
+    // Check if entry exists (with or without newline)
+    const regex = new RegExp(`^${entry.replace(/\//g, '\\/')}$`, 'm');
+    return !regex.test(gitignoreContent);
+  });
+
+  // Add missing entries
+  if (missingEntries.length > 0) {
+    if (gitignoreContent && !gitignoreContent.endsWith('\n')) {
+      gitignoreContent += '\n';
+    }
+    gitignoreContent += '\n# Cypress parallel test results (added by dceky)\n';
+    missingEntries.forEach((entry) => {
+      gitignoreContent += `${entry}\n`;
+    });
+    writeFileSync(gitignorePath, gitignoreContent, 'utf8');
+    console.log(`Added ${missingEntries.length} entries to .gitignore`);
+  }
+};
+
+export default addToGitIgnore;

package/setup/checkRequiredFiles.ts

@@ -0,0 +1,63 @@
+/* eslint-disable no-console */
+import { existsSync } from 'fs';
+import path from 'path';
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Ensure required configuration files exist in the consumer repo
+ * @author Yuen Ler Chow
+ */
+const checkRequiredFiles = (): void => {
+  const root = getRootPath();
+
+  const globalsPath = path.join(root, 'cypress/globals');
+  const profilesPath = path.join(root, 'cypress/profiles');
+
+  // Common file extensions to check
+  const extensions = ['.js', '.ts', '.json', '.mjs', '.cjs'];
+
+  // Required global files
+  const requiredGlobals = [
+    'GlobalCredentials',
+    'GlobalResources',
+    'GlobalValues',
+  ];
+
+  // Determine profile file name (default is stage)
+  const profileName = process.env.CYPRESS_PROFILE || 'stage';
+  const requiredProfile = `${profileName}.Profile`;
+
+  // Check for missing files
+  const missingFiles: string[] = [];
+
+  // Check global files
+  requiredGlobals.forEach((file) => {
+    const filePath = path.join(globalsPath, file);
+    const found = extensions.some((ext) => {
+      return existsSync(`${filePath}${ext}`);
+    });
+    if (!found) {
+      missingFiles.push(`cypress/globals/${file}.ts`);
+    }
+  });
+
+  // Check profile file
+  const profileFilePath = path.join(profilesPath, requiredProfile);
+  const profileFound = extensions.some((ext) => {
+    return existsSync(`${profileFilePath}${ext}`);
+  });
+  if (!profileFound) {
+    missingFiles.push(`cypress/profiles/${requiredProfile}.ts`);
+  }
+
+  if (missingFiles.length > 0) {
+    console.error('\nMissing required configuration files in this project:');
+    missingFiles.forEach((file) => {
+      console.error(`  - ${file}`);
+    });
+    console.error('\nPlease create these files before running setup.');
+    process.exit(1);
+  }
+};
+
+export default checkRequiredFiles;

package/setup/genCommandImportFile.ts

@@ -0,0 +1,76 @@
+import fs from 'fs';
+import path from 'path';
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Generate an index.ts file that imports and runs all command files in cypress/commands
+ * This should be called from cypress.config.js
+ * @author Yuen Ler Chow
+ */
+const genCommandImportFile = () => {
+  const root = getRootPath();
+
+  const cypressCommandsDir = path.join(root, 'cypress/commands');
+  const outputFile = path.join(cypressCommandsDir, 'index.ts');
+  const topOfFileComment = '// Auto-generated by dceky - do not edit manually';
+
+  // Check if the directory exists
+  if (!fs.existsSync(cypressCommandsDir)) {
+    // Create the directory
+    fs.mkdirSync(cypressCommandsDir, { recursive: true });
+    // Create an empty file so init doesn't fail
+    fs.writeFileSync(outputFile, `${topOfFileComment}\n`);
+    return outputFile;
+  }
+
+  // Get all files in the directory
+  const files = fs.readdirSync(cypressCommandsDir);
+  const commandFiles: string[] = [];
+
+  // Filter out non-JS/TS files and process each file
+  files.forEach((file) => {
+    // Skip non-JS/TS files (like .d.ts, .map, etc.)
+    if (!file.endsWith('.js') && !file.endsWith('.ts')) {
+      return;
+    }
+
+    // Skip index files
+    if (file === 'index.js' || file === 'index.ts') {
+      return;
+    }
+
+    // Determine the file's path
+    const filePath = path.join(cypressCommandsDir, file);
+
+    // Check if it's a file (not a directory)
+    const stats = fs.statSync(filePath);
+    if (!stats.isFile()) {
+      return;
+    }
+
+    // Store the file name
+    commandFiles.push(file);
+  });
+
+  // Generate require statements and function calls
+  const requires: string[] = [];
+  const calls: string[] = [];
+
+  commandFiles.forEach((file) => {
+    const requirePath = `./${file}`;
+    // Create a safe variable name (replace non-alphanumeric with underscore)
+    const importName = file.replace(/\.(js|ts)$/, '');
+    const varName = importName.replace(/[^a-zA-Z0-9]/g, '_');
+
+    requires.push(`const ${varName} = require('${requirePath}');`);
+    calls.push(`${varName}.default();`);
+  });
+
+  // Build the final content
+  const content = `${topOfFileComment}\n${requires.join('\n')}\n\n${calls.join('\n')}`;
+
+  // Write to the output file
+  fs.writeFileSync(outputFile, content, 'utf8');
+};
+
+export default genCommandImportFile;

package/setup/genDynamicConfigFile.ts

@@ -0,0 +1,29 @@
+import fs from 'fs';
+import path from 'path';
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Generate the dynamic configuration file
+ */
+const genDynamicConfigFile = (): string => {
+  const root = getRootPath();
+
+  const outputFile = path.join(root, 'cypress.config.ts');
+
+  // Create the dynamic configuration file
+  const dynamicConfigFile = [
+    '// Auto-generated by dceky - do not edit manually',
+    '',
+    'import { genConfiguration } from \'dceky\';',
+    '',
+    'export default genConfiguration();',
+    '',
+  ].join('\n');
+
+  // Write the configuration file directly
+  fs.writeFileSync(outputFile, dynamicConfigFile, 'utf8');
+
+  return outputFile;
+};
+
+export default genDynamicConfigFile;

package/setup/helpers/getRootPath.ts

@@ -0,0 +1,13 @@
+import path from 'path';
+
+/**
+ * Get the root path of the project
+ * @author Yuen Ler Chow
+ * @returns the root path of the project
+ */
+const getRootPath = () => {
+  const root = path.join(__dirname, '../../../../');
+  return root;
+};
+
+export default getRootPath;

package/setup/index.ts

@@ -0,0 +1,11 @@
+import genCommandImportFile from './genCommandImportFile';
+import genDynamicConfigFile from './genDynamicConfigFile';
+import addToGitIgnore from './addToGitIgnore';
+import setupCypressDependencies from './setupCypressDependencies';
+import checkRequiredFiles from './checkRequiredFiles';
+
+checkRequiredFiles();
+genCommandImportFile();
+genDynamicConfigFile();
+addToGitIgnore();
+setupCypressDependencies();

package/setup/setupCypressDependencies.ts

@@ -0,0 +1,38 @@
+/* eslint-disable no-console */
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Ensure required packages exist in the consumer repo
+ * @author Yuen Ler Chow
+ */
+const setupCypressDependencies = (): void => {
+  const root = getRootPath();
+
+  const requiredPkgs = [
+    'cypress-parallel',
+    'cypress-multi-reporters',
+    'mochawesome',
+    'mochawesome-merge',
+    'mochawesome-report-generator',
+  ];
+
+  const missingPkgs = requiredPkgs.filter((pkg) => {
+    try {
+      // Resolve from the consumer project root
+      require.resolve(pkg, { paths: [root] });
+      return false;
+    } catch {
+      return true;
+    }
+  });
+
+  if (missingPkgs.length > 0) {
+    const installCmd = `npm i -D ${missingPkgs.join(' ')}`;
+    console.error(`\nMissing required devDependencies in this project: ${missingPkgs.join(', ')}`);
+    console.error('Run the following command, then try again:');
+    console.error(`\n${installCmd}\n`);
+    process.exit(1);
+  }
+};
+
+export default setupCypressDependencies;

package/src/commands/assertDoesNotHaveClass.ts

@@ -0,0 +1,51 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Assert that an element does not have a specific className
+       * @author Yuen Ler Chow
+       * @param opts object containing all arguments
+       * @param opts.item the css selector for finding the element
+       * @param opts.className the className to check for
+       * @return Cypress chainable containing the element that was checked
+       */
+      assertDoesNotHaveClass(
+        opts: {
+          item: string,
+          className: string,
+        },
+      ): Chainable<JQuery<HTMLElement>>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const assertDoesNotHaveClass = () => {
+  Cypress.Commands.add(
+    'assertDoesNotHaveClass',
+    (
+      opts: {
+        item: string,
+        className: string,
+      },
+    ) => {
+      cy.log(`Assert ${opts.item} does not have class ${opts.className}`);
+      return cy.get(opts.item).should('not.have.class', opts.className);
+    },
+  );
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default assertDoesNotHaveClass;

package/src/commands/assertHasClass.ts

@@ -0,0 +1,51 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Assert that an element has a specific className
+       * @author Yuen Ler Chow
+       * @param opts object containing all arguments
+       * @param opts.item the css selector for finding the element
+       * @param opts.className the className to check for
+       * @return Cypress chainable containing the element that was checked
+       */
+      assertHasClass(
+        opts: {
+          item: string,
+          className: string,
+        },
+      ): Chainable<JQuery<HTMLElement>>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const assertHasClass = () => {
+  Cypress.Commands.add(
+    'assertHasClass',
+    (
+      opts: {
+        item: string,
+        className: string,
+      },
+    ) => {
+      cy.log(`Assert ${opts.item} has class ${opts.className}`);
+      return cy.get(opts.item).should('have.class', opts.className);
+    },
+  );
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default assertHasClass;