dceky 1.0.5-beta.ky-declarations.8 → 1.0.5-beta.ky-declarations.10

package/lib/postinstall/helpers/exec.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Execute a command
+ * @author Gabe Abrams
+ * @param command the command to execute
+ * @param printToStdOut if true, print to standard out instead of returning
+ */
+declare const exec: (command: string, printToStdOut?: boolean) => string;
+export default exec;

package/lib/postinstall/helpers/exec.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var child_process_1 = require("child_process");
+/**
+ * Execute a command
+ * @author Gabe Abrams
+ * @param command the command to execute
+ * @param printToStdOut if true, print to standard out instead of returning
+ */
+var exec = function (command, printToStdOut) {
+    if (printToStdOut) {
+        (0, child_process_1.execSync)(command, { stdio: 'inherit' });
+        return '';
+    }
+    return (0, child_process_1.execSync)(command).toString();
+};
+exports.default = exec;
+//# sourceMappingURL=exec.js.map

package/lib/postinstall/helpers/exec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exec.js","sourceRoot":"","sources":["../../../postinstall/helpers/exec.ts"],"names":[],"mappings":";;AAAA,+CAAyC;AAEzC;;;;;GAKG;AACH,IAAM,IAAI,GAAG,UAAC,OAAe,EAAE,aAAuB;IACpD,IAAI,aAAa,EAAE,CAAC;QAClB,IAAA,wBAAQ,EAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,IAAA,wBAAQ,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/lib/postinstall/helpers/getRootPath.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the root path of the project
+ * @author Yuen Ler Chow
+ * @returns the root path of the project
+ */
+declare const getRootPath: () => string;
+export default getRootPath;

package/lib/postinstall/helpers/getRootPath.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var path_1 = __importDefault(require("path"));
+/**
+ * Get the root path of the project
+ * @author Yuen Ler Chow
+ * @returns the root path of the project
+ */
+var getRootPath = function () {
+    var root = path_1.default.join(__dirname, '../../../../');
+    return root;
+};
+exports.default = getRootPath;
+//# sourceMappingURL=getRootPath.js.map

package/lib/postinstall/helpers/getRootPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRootPath.js","sourceRoot":"","sources":["../../../postinstall/helpers/getRootPath.ts"],"names":[],"mappings":";;;;;AAAA,8CAAwB;AAExB;;;;GAIG;AACH,IAAM,WAAW,GAAG;IAClB,IAAM,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/lib/postinstall/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Adds scripts to the top-level project
+ * @author Gabe Abrams
+ */
+export {};

package/lib/postinstall/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/* eslint-disable no-console */
+/**
+ * Adds scripts to the top-level project
+ * @author Gabe Abrams
+ */
+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 exec_1 = __importDefault(require("./helpers/exec"));
+var getRootPath_1 = __importDefault(require("./helpers/getRootPath"));
+// Get the project directory
+var root = (0, getRootPath_1.default)();
+// Read the root package.json
+// eslint-disable-next-line global-require, import/no-dynamic-require
+var pkgJson = require(path_1.default.join(root, 'package.json'));
+// Ensure scripts field exists
+if (!pkgJson.scripts) {
+    pkgJson.scripts = {};
+}
+// Keep track if something was modified
+var modified = false;
+// Add ky:setup script
+if (!pkgJson.scripts['ky:setup']) {
+    pkgJson.scripts['ky:setup'] = 'npm explore dceky -- npm run ky:setup';
+    modified = true;
+}
+// Add ky:start script
+if (!pkgJson.scripts['ky:start']) {
+    pkgJson.scripts['ky:start'] = 'npm explore dceky -- npm run ky:start';
+    modified = true;
+}
+// Add ky:dev script
+if (!pkgJson.scripts['ky:dev']) {
+    pkgJson.scripts['ky:dev'] = 'npm explore dceky -- npm run ky:dev';
+    modified = true;
+}
+// Write back the modified package.json
+fs_1.default.writeFileSync(path_1.default.join(root, 'package.json'), JSON.stringify(pkgJson, null, 2), 'utf8');
+// Automatically set up
+if (modified) {
+    console.log('\nRunning initial ky setup...');
+    (0, exec_1.default)("cd ".concat(root, " && npm run ky:setup"), true);
+}
+// Notify user
+if (modified) {
+    console.log('\nAdded dceky scripts to package.json');
+    console.log('You can now run:');
+    console.log('  npm run ky:start   # Start ky tests');
+    console.log('  npm run ky:setup   # Setup or update ky-managed files in this project');
+    console.log('  npm run ky:dev     # Start ky tests after ensuring set up');
+}
+//# sourceMappingURL=index.js.map

package/lib/postinstall/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../postinstall/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B;;;GAGG;;;;;AAEH,cAAc;AACd,0CAAoB;AACpB,8CAAwB;AAExB,iBAAiB;AACjB,wDAAkC;AAClC,sEAAgD;AAEhD,4BAA4B;AAC5B,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;AAE3B,6BAA6B;AAC7B,qEAAqE;AACrE,IAAM,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;AAEzD,8BAA8B;AAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;AACvB,CAAC;AAED,uCAAuC;AACvC,IAAI,QAAQ,GAAG,KAAK,CAAC;AAErB,sBAAsB;AACtB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;IACjC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,uCAAuC,CAAC;IACtE,QAAQ,GAAG,IAAI,CAAC;AAClB,CAAC;AAED,sBAAsB;AACtB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;IACjC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,uCAAuC,CAAC;IACtE,QAAQ,GAAG,IAAI,CAAC;AAClB,CAAC;AAED,oBAAoB;AACpB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC/B,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,qCAAqC,CAAC;IAClE,QAAQ,GAAG,IAAI,CAAC;AAClB,CAAC;AAED,uCAAuC;AACvC,YAAE,CAAC,aAAa,CACd,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,EAC/B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAChC,MAAM,CACP,CAAC;AAEF,uBAAuB;AACvB,IAAI,QAAQ,EAAE,CAAC;IACb,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC7C,IAAA,cAAI,EAAC,aAAM,IAAI,yBAAsB,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,cAAc;AACd,IAAI,QAAQ,EAAE,CAAC;IACb,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,yEAAyE,CAAC,CAAC;IACvF,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;AAC7E,CAAC"}

package/lib/setup/index.js

@@ -10,11 +10,11 @@ var setupCypressDependencies_1 = __importDefault(require("./setupCypressDependen
 var checkRequiredFiles_1 = __importDefault(require("./checkRequiredFiles"));
 var genE2ELaunchFile_1 = __importDefault(require("./genE2ELaunchFile"));
 var genKyCommandDeclarations_1 = __importDefault(require("./genKyCommandDeclarations"));
+(0, setupCypressDependencies_1.default)();
 (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;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"}
+{"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,kCAAwB,GAAE,CAAC;AAC3B,IAAA,4BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,wBAAc,GAAE,CAAC;AACjB,IAAA,0BAAgB,GAAE,CAAC;AACnB,IAAA,kCAAwB,GAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.0.5-beta.ky-declarations.8",
+  "version": "1.0.5-beta.ky-declarations.10",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
@@ -8,7 +8,9 @@
     "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"
+    "ky:dev": "npm run ky:setup && npm run ky:start",
+    "preinstall": "npx tsx ./preinstall/index.ts",
+    "postinstall": "npx tsx ./postinstall/index.ts"
   },
   "repository": {
     "type": "git",

package/postinstall/helpers/exec.ts

@@ -0,0 +1,17 @@
+import { execSync } from 'child_process';
+
+/**
+ * Execute a command
+ * @author Gabe Abrams
+ * @param command the command to execute
+ * @param printToStdOut if true, print to standard out instead of returning
+ */
+const exec = (command: string, printToStdOut?: boolean): string => {
+  if (printToStdOut) {
+    execSync(command, { stdio: 'inherit' });
+    return '';
+  }
+  return execSync(command).toString();
+};
+
+export default exec;

package/postinstall/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/postinstall/index.ts

@@ -0,0 +1,68 @@
+/* eslint-disable no-console */
+/**
+ * Adds scripts to the top-level project
+ * @author Gabe Abrams
+ */
+
+// Import libs
+import fs from 'fs';
+import path from 'path';
+
+// Import helpers
+import exec from './helpers/exec';
+import getRootPath from './helpers/getRootPath';
+
+// Get the project directory
+const root = getRootPath();
+
+// Read the root package.json
+// eslint-disable-next-line global-require, import/no-dynamic-require
+const pkgJson = require(path.join(root, 'package.json'));
+
+// Ensure scripts field exists
+if (!pkgJson.scripts) {
+  pkgJson.scripts = {};
+}
+
+// Keep track if something was modified
+let modified = false;
+
+// Add ky:setup script
+if (!pkgJson.scripts['ky:setup']) {
+  pkgJson.scripts['ky:setup'] = 'npm explore dceky -- npm run ky:setup';
+  modified = true;
+}
+
+// Add ky:start script
+if (!pkgJson.scripts['ky:start']) {
+  pkgJson.scripts['ky:start'] = 'npm explore dceky -- npm run ky:start';
+  modified = true;
+}
+
+// Add ky:dev script
+if (!pkgJson.scripts['ky:dev']) {
+  pkgJson.scripts['ky:dev'] = 'npm explore dceky -- npm run ky:dev';
+  modified = true;
+}
+
+// Write back the modified package.json
+fs.writeFileSync(
+  path.join(root, 'package.json'),
+  JSON.stringify(pkgJson, null, 2),
+  'utf8',
+);
+
+// Automatically set up
+if (modified) {
+  console.log('\nRunning initial ky setup...');
+  exec(`cd ${root} && npm run ky:setup`, true);
+}
+
+// Notify user
+if (modified) {
+  console.log('\nAdded dceky scripts to package.json');
+  console.log('You can now run:');
+  console.log('  npm run ky:start   # Start ky tests');
+  console.log('  npm run ky:setup   # Setup or update ky-managed files in this project');
+  console.log('  npm run ky:dev     # Start ky tests after ensuring set up');
+}

package/preinstall/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/preinstall/index.ts

@@ -0,0 +1,26 @@
+/* eslint-disable no-console */
+/**
+ * Make sure cypress folder is created
+ * @author Gabe Abrams
+ */
+
+// Import libs
+import fs from 'fs';
+import path from 'path';
+
+// Import helpers
+import getRootPath from './helpers/getRootPath';
+
+// Get the project directory
+const root = getRootPath();
+
+// Check for cypress folder
+const cypressDir = path.join(root, 'cypress');
+const cypressExists = fs.existsSync(cypressDir);
+if (!cypressExists) {
+  console.log('Install cypress before installing dceky:');
+  console.log('1. Run "npm i cypress --save-dev"');
+  console.log('2. Run "npx cypress open" and follow configuration instructions');
+  console.log('3. Run "npm i dceky --save-dev');
+  process.exit(1);
+}

package/setup/index.ts

@@ -6,10 +6,10 @@ import checkRequiredFiles from './checkRequiredFiles';
 import genE2ELaunchFile from './genE2ELaunchFile';
 import genKyCommandDeclarations from './genKyCommandDeclarations';
 
+setupCypressDependencies();
 checkRequiredFiles();
 genCommandImportFile();
 genDynamicConfigFile();
 addToGitIgnore();
-setupCypressDependencies();
 genE2ELaunchFile();
 genKyCommandDeclarations();

package/tsconfig.json

@@ -11,7 +11,13 @@
     "lib": ["es5", "es2015.promise", "es2017.object", "dom"],
     "outDir": "./lib"
   },
-  "include": [ "./src", "setup", "start" ],
+  "include": [
+    "./src",
+    "setup",
+    "start",
+    "preinstall",
+    "postinstall"
+  ],
   "ts-node": {
     "files": true
   }