dceky 1.0.4-beta.new-divided-export.6 → 1.0.5-beta.ky-declarations.1

package/lib/setup/genE2ELaunchFile.js

@@ -19,6 +19,7 @@ var genE2ELaunchFile = function () {
         '// Auto-generated by dceky - do not edit manually',
         '',
         'import commands from \'dceky\';',
+        'import \'./kyCommandDeclarations.ts\';',
         'import \'../commands\';',
         '',
         'commands();',

package/lib/setup/genE2ELaunchFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"genE2ELaunchFile.js","sourceRoot":"","sources":["../../setup/genE2ELaunchFile.ts"],"names":[],"mappings":";;;;;AAAA,0CAAoB;AACpB,8CAAwB;AACxB,sEAAgD;AAEhD;;;;GAIG;AACH,IAAM,gBAAgB,GAAG;IACvB,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAE9D,wCAAwC;IACxC,IAAM,UAAU,GAAG;QACjB,mDAAmD;QACnD,EAAE;QACF,iCAAiC;QACjC,yBAAyB;QACzB,EAAE;QACF,aAAa;QACb,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,wCAAwC;IACxC,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAEjD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}
+{"version":3,"file":"genE2ELaunchFile.js","sourceRoot":"","sources":["../../setup/genE2ELaunchFile.ts"],"names":[],"mappings":";;;;;AAAA,0CAAoB;AACpB,8CAAwB;AACxB,sEAAgD;AAEhD;;;;GAIG;AACH,IAAM,gBAAgB,GAAG;IACvB,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAE9D,wCAAwC;IACxC,IAAM,UAAU,GAAG;QACjB,mDAAmD;QACnD,EAAE;QACF,iCAAiC;QACjC,wCAAwC;QACxC,yBAAyB;QACzB,EAAE;QACF,aAAa;QACb,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,wCAAwC;IACxC,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAEjD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/lib/setup/genKyCommandDeclarations.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generate a single, unified command declarations file for Ky functions
+ * @author Gabe Abrams
+ */
+declare const genKyCommandDeclarations: () => void;
+export default genKyCommandDeclarations;

package/lib/setup/genKyCommandDeclarations.js

@@ -0,0 +1,100 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import packages
+var fs_1 = __importDefault(require("fs"));
+var path_1 = __importDefault(require("path"));
+// Import shared helpers
+var getRootPath_1 = __importDefault(require("./helpers/getRootPath"));
+/**
+ * Generate a single, unified command declarations file for Ky functions
+ * @author Gabe Abrams
+ */
+var genKyCommandDeclarations = function () {
+    var root = (0, getRootPath_1.default)();
+    // Get paths
+    var kyCommandsDir = path_1.default.join(root, 'node_modules/dceky/src/commands');
+    var declarationsPath = path_1.default.join(root, 'cypress/e2e/kyCommandDeclarations.ts');
+    // Find all command files
+    var commandFiles = (fs_1.default
+        // Read all files in the commands directory
+        .readdirSync(kyCommandsDir)
+        // Only include .ts files
+        .filter(function (file) {
+        return file.endsWith('.ts');
+    })
+        // Exclude index file
+        .filter(function (file) {
+        return file !== 'index.ts';
+    }));
+    // Read the files, extract declarations
+    var unprocessedDeclarations = [];
+    for (var i = 0; i < commandFiles.length; i += 1) {
+        var file = commandFiles[i];
+        var filePath = path_1.default.join(kyCommandsDir, file);
+        var fileContents = fs_1.default.readFileSync(filePath, 'utf8');
+        // Extract declaration section
+        // Format:
+        // /*----------------------------------------*/
+        // /* ---------------- Type ---------------- */
+        // /*----------------------------------------*/
+        // [Declaration]
+        // /*----------------------------------------*/
+        // /* --------------- Command -------------- */
+        // /*----------------------------------------*/
+        var declarationMatch = fileContents.match(
+        // eslint-disable-next-line max-len
+        /\/\*[-]{40,}\*\/\s*\/\* [-]{16} Type [-]{16} \*\/\s*\/\*[-]{40,}\*\/\s*([\s\S]*?)\s*\/\*[-]{40,}\*\/\s*\/\* [-]{15} Command [-]{15} \*\/\s*\/\*[-]{40,}\*\//);
+        if (declarationMatch
+            && declarationMatch[1]
+            && declarationMatch[1].trim()) {
+            unprocessedDeclarations.push(declarationMatch[1].trim());
+        }
+    }
+    // Process each declaration
+    var processedDeclarations = unprocessedDeclarations.map(function (declaration) {
+        // Declaration is wrapped in:
+        // declare global {
+        //   namespace Cypress {
+        //     interface Chainable {
+        //       [Processed Declaration]
+        //     }
+        //   }
+        // }
+        var match = declaration.match(/declare global \{\s*namespace Cypress \{\s*interface Chainable \{\s*([\s\S]*?)\s*\}\s*\}\s*\}/);
+        if (match && match[1] && match[1].trim()) {
+            return match[1].trim();
+        }
+        return '';
+    });
+    // Merge declarations into one and re-wrap
+    var finalDeclarations = __spreadArray(__spreadArray([
+        '/// <reference types="cypress" />',
+        '',
+        '// Auto-generated by dceky - do not edit manually',
+        '',
+        'declare global {',
+        '  namespace Cypress {',
+        '    interface Chainable {'
+    ], processedDeclarations, true), [
+        '    }',
+        '  }',
+        '}',
+        '',
+    ], false).join('\n');
+    // Write to file
+    fs_1.default.writeFileSync(declarationsPath, finalDeclarations, 'utf8');
+};
+exports.default = genKyCommandDeclarations;
+//# sourceMappingURL=genKyCommandDeclarations.js.map

package/lib/setup/genKyCommandDeclarations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genKyCommandDeclarations.js","sourceRoot":"","sources":["../../setup/genKyCommandDeclarations.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kBAAkB;AAClB,0CAAoB;AACpB,8CAAwB;AAExB,wBAAwB;AACxB,sEAAgD;AAEhD;;;GAGG;AACH,IAAM,wBAAwB,GAAG;IAC/B,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,YAAY;IACZ,IAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;IACzE,IAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;IAEjF,yBAAyB;IACzB,IAAM,YAAY,GAAG,CACnB,YAAE;QACA,2CAA2C;SAC1C,WAAW,CAAC,aAAa,CAAC;QAC3B,yBAAyB;SACxB,MAAM,CAAC,UAAC,IAAI;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;QACF,qBAAqB;SACpB,MAAM,CAAC,UAAC,IAAI;QACX,OAAO,IAAI,KAAK,UAAU,CAAC;IAC7B,CAAC,CAAC,CACL,CAAC;IAEF,uCAAuC;IACvC,IAAM,uBAAuB,GAAa,EAAE,CAAC;IAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,IAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAChD,IAAM,YAAY,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEvD,8BAA8B;QAC9B,UAAU;QACV,+CAA+C;QAC/C,+CAA+C;QAC/C,+CAA+C;QAC/C,gBAAgB;QAChB,+CAA+C;QAC/C,+CAA+C;QAC/C,+CAA+C;QAC/C,IAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK;QACzC,mCAAmC;QACnC,6JAA6J,CAC9J,CAAC;QACF,IACE,gBAAgB;eACb,gBAAgB,CAAC,CAAC,CAAC;eACnB,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAC7B,CAAC;YACD,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,2BAA2B;IAC3B,IAAM,qBAAqB,GAAG,uBAAuB,CAAC,GAAG,CAAC,UAAC,WAAW;QACpE,6BAA6B;QAC7B,mBAAmB;QACnB,wBAAwB;QACxB,4BAA4B;QAC5B,gCAAgC;QAChC,QAAQ;QACR,MAAM;QACN,IAAI;QACJ,IAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAC7B,+FAA+F,CAChG,CAAC;QACF,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACzC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,0CAA0C;IAC1C,IAAM,iBAAiB,GAAG;QACxB,mCAAmC;QACnC,EAAE;QACF,mDAAmD;QACnD,EAAE;QACF,kBAAkB;QAClB,uBAAuB;QACvB,2BAA2B;OAExB,qBAAqB;QACxB,OAAO;QACP,KAAK;QACL,GAAG;QACH,EAAE;cACF,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,gBAAgB;IAChB,YAAE,CAAC,aAAa,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,kBAAe,wBAAwB,CAAC"}

package/lib/setup/index.js

@@ -9,10 +9,12 @@ var addToGitIgnore_1 = __importDefault(require("./addToGitIgnore"));
 var setupCypressDependencies_1 = __importDefault(require("./setupCypressDependencies"));
 var checkRequiredFiles_1 = __importDefault(require("./checkRequiredFiles"));
 var genE2ELaunchFile_1 = __importDefault(require("./genE2ELaunchFile"));
+var genKyCommandDeclarations_1 = __importDefault(require("./genKyCommandDeclarations"));
 (0, checkRequiredFiles_1.default)();
 (0, genCommandImportFile_1.default)();
 (0, genDynamicConfigFile_1.default)();
 (0, addToGitIgnore_1.default)();
 (0, setupCypressDependencies_1.default)();
 (0, genE2ELaunchFile_1.default)();
+(0, genKyCommandDeclarations_1.default)();
 //# sourceMappingURL=index.js.map

package/lib/setup/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../setup/index.ts"],"names":[],"mappings":";;;;;AAAA,gFAA0D;AAC1D,gFAA0D;AAC1D,oEAA8C;AAC9C,wFAAkE;AAClE,4EAAsD;AACtD,wEAAkD;AAElD,IAAA,4BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,wBAAc,GAAE,CAAC;AACjB,IAAA,kCAAwB,GAAE,CAAC;AAC3B,IAAA,0BAAgB,GAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../setup/index.ts"],"names":[],"mappings":";;;;;AAAA,gFAA0D;AAC1D,gFAA0D;AAC1D,oEAA8C;AAC9C,wFAAkE;AAClE,4EAAsD;AACtD,wEAAkD;AAClD,wFAAkE;AAElE,IAAA,4BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,wBAAc,GAAE,CAAC;AACjB,IAAA,kCAAwB,GAAE,CAAC;AAC3B,IAAA,0BAAgB,GAAE,CAAC;AACnB,IAAA,kCAAwB,GAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.0.4-beta.new-divided-export.6",
+  "version": "1.0.5-beta.ky-declarations.1",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",

package/setup/genE2ELaunchFile.ts

@@ -17,6 +17,7 @@ const genE2ELaunchFile = (): string => {
     '// Auto-generated by dceky - do not edit manually',
     '',
     'import commands from \'dceky\';',
+    'import \'./kyCommandDeclarations.ts\';',
     'import \'../commands\';',
     '',
     'commands();',

package/setup/genKyCommandDeclarations.ts

@@ -0,0 +1,103 @@
+// Import packages
+import fs from 'fs';
+import path from 'path';
+
+// Import shared helpers
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Generate a single, unified command declarations file for Ky functions
+ * @author Gabe Abrams
+ */
+const genKyCommandDeclarations = () => {
+  const root = getRootPath();
+
+  // Get paths
+  const kyCommandsDir = path.join(root, 'node_modules/dceky/src/commands');
+  const declarationsPath = path.join(root, 'cypress/e2e/kyCommandDeclarations.ts');
+
+  // Find all command files
+  const commandFiles = (
+    fs
+      // Read all files in the commands directory
+      .readdirSync(kyCommandsDir)
+      // Only include .ts files
+      .filter((file) => {
+        return file.endsWith('.ts');
+      })
+      // Exclude index file
+      .filter((file) => {
+        return file !== 'index.ts';
+      })
+  );
+
+  // Read the files, extract declarations
+  const unprocessedDeclarations: string[] = [];
+  for (let i = 0; i < commandFiles.length; i += 1) {
+    const file = commandFiles[i];
+    const filePath = path.join(kyCommandsDir, file);
+    const fileContents = fs.readFileSync(filePath, 'utf8');
+
+    // Extract declaration section
+    // Format:
+    // /*----------------------------------------*/
+    // /* ---------------- Type ---------------- */
+    // /*----------------------------------------*/
+    // [Declaration]
+    // /*----------------------------------------*/
+    // /* --------------- Command -------------- */
+    // /*----------------------------------------*/
+    const declarationMatch = fileContents.match(
+      // eslint-disable-next-line max-len
+      /\/\*[-]{40,}\*\/\s*\/\* [-]{16} Type [-]{16} \*\/\s*\/\*[-]{40,}\*\/\s*([\s\S]*?)\s*\/\*[-]{40,}\*\/\s*\/\* [-]{15} Command [-]{15} \*\/\s*\/\*[-]{40,}\*\//,
+    );
+    if (
+      declarationMatch
+      && declarationMatch[1]
+      && declarationMatch[1].trim()
+    ) {
+      unprocessedDeclarations.push(declarationMatch[1].trim());
+    }
+  }
+
+  // Process each declaration
+  const processedDeclarations = unprocessedDeclarations.map((declaration) => {
+    // Declaration is wrapped in:
+    // declare global {
+    //   namespace Cypress {
+    //     interface Chainable {
+    //       [Processed Declaration]
+    //     }
+    //   }
+    // }
+    const match = declaration.match(
+      /declare global \{\s*namespace Cypress \{\s*interface Chainable \{\s*([\s\S]*?)\s*\}\s*\}\s*\}/,
+    );
+    if (match && match[1] && match[1].trim()) {
+      return match[1].trim();
+    }
+    return '';
+  });
+
+  // Merge declarations into one and re-wrap
+  const finalDeclarations = [
+    '/// <reference types="cypress" />',
+    '',
+    '// Auto-generated by dceky - do not edit manually',
+    '',
+    'declare global {',
+    '  namespace Cypress {',
+    '    interface Chainable {',
+    // Indent each declaration by 6 spaces
+    ...processedDeclarations,
+    '    }',
+    '  }',
+    '}',
+    '',
+  ].join('\n');
+
+  // Write to file
+  fs.writeFileSync(declarationsPath, finalDeclarations, 'utf8');
+};
+
+export default genKyCommandDeclarations;

package/setup/index.ts

@@ -4,6 +4,7 @@ import addToGitIgnore from './addToGitIgnore';
 import setupCypressDependencies from './setupCypressDependencies';
 import checkRequiredFiles from './checkRequiredFiles';
 import genE2ELaunchFile from './genE2ELaunchFile';
+import genKyCommandDeclarations from './genKyCommandDeclarations';
 
 checkRequiredFiles();
 genCommandImportFile();
@@ -11,3 +12,4 @@ genDynamicConfigFile();
 addToGitIgnore();
 setupCypressDependencies();
 genE2ELaunchFile();
+genKyCommandDeclarations();