dceky 1.0.0-beta-profile.1 → 1.0.0-beta-yuenler.2

package/profileChooser/helpers/showChooser.ts

@@ -1,95 +0,0 @@
-import clear from 'clear';
-
-// Import shared helpers
-import print from './print';
-import prompt from './prompt';
-
-// Import shared types
-import ChooserOption from '../types/ChooserOption';
-
-/**
- * Show a chooser between many options
- * @author Gabe Abrams
- * @param question the question to ask
- * @param options list of options to choose from
- * @param title main title to show above the choices
- * @param dontClear if true, don't clear the console before
- * @returns chosen option
- */
-const showChooser = (
-  opts: {
-    question: string,
-    options: ChooserOption[],
-    title?: string,
-    dontClear?: boolean,
-  },
-): {
-  description: string,
-  tag: string,
-  index: number,
-} => {
-  const {
-    question,
-    options,
-    title,
-    dontClear,
-  } = opts;
-
-  // Print the header
-  if (!dontClear) {
-    clear();
-  }
-  if (title) {
-    print.title(title);
-    console.log('');
-  }
-  print.subtitle(question);
-
-  // Make sure all options have tags
-  let nextNumber = 1;
-  const optionsWithTags = options.map((option) => {
-    // Get/generate a tag
-    let { tag } = option;
-    if (!tag) {
-      tag = String(nextNumber);
-      nextNumber += 1;
-    }
-
-    // Return complete option
-    return {
-      ...option,
-      tag,
-    };
-  });
-
-  // Print options
-  for (let i = 0; i < optionsWithTags.length; i++) {
-    console.log(`${optionsWithTags[i].tag} - ${optionsWithTags[i].description}`);
-  }
-
-  // Ask user to choose
-  const responseTag = prompt('> ').trim();
-
-  // Find the appropriate option
-  for (let i = 0; i < optionsWithTags.length; i++) {
-    if (responseTag.toLowerCase() === optionsWithTags[i].tag.toLowerCase()) {
-      // Found the right option
-      return {
-        ...optionsWithTags[i],
-        index: i,
-      };
-    }
-  }
-
-  // No tag found
-  clear();
-  print.title('Invalid Choice');
-  console.log('');
-  print.enterToContinue();
-  return showChooser({
-    question,
-    options: optionsWithTags,
-  });
-};
-
-export default showChooser;

package/profileChooser/types/ChooserOption.ts

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

package/src/commands/clickSomething.ts

@@ -1,33 +0,0 @@
-/// <reference types="cypress" />
-
-/*----------------------------------------*/
-/* ---------------- Type ---------------- */
-/*----------------------------------------*/
-
-declare global {
-  namespace Cypress {
-    interface Chainable {
-      /**
-       * Custom command to click an element by selector
-       * @example cy.clickSomething('.my-button')
-       */
-      clickSomething(selector: string): Chainable<Element>;
-    }
-  }
-}
-
-/*----------------------------------------*/
-/* --------------- Command -------------- */
-/*----------------------------------------*/
-
-const clickSomething = () => {
-  Cypress.Commands.add('clickSomething', (selector: string) => {
-    cy.get(selector).click();
-  });
-};
-
-/*----------------------------------------*/
-/* --------------- Export --------------- */
-/*----------------------------------------*/
-
-export default clickSomething;

package/src/genConfiguration/helpers/resolveDependents.ts

@@ -1,47 +0,0 @@
- 
-// Import shared types
-import type GlobalsOrProfile from '../types/GlobalsOrProfile';
-import type DependentValue from '../types/DependentValue';
-
-/**
- * Resolve all dependent values using already-merged basics.
- * @author Gardenia Liu
- * @param dependentMaps with dependencies on basics
- * @param basics entries
- * @returns env with all dependent values resolved
- */
-const resolveDependents = (
-  dependentMaps: { [k: string]: DependentValue }[],
-  basics: GlobalsOrProfile,
-): GlobalsOrProfile => {
-  const resolved: GlobalsOrProfile = {};
-
-  // Loop through all of the dependency maps
-  dependentMaps.forEach((depMap) => {
-    // Loop through all entries within dependency map
-    Object.entries(depMap).forEach(([k, depVal]) => {
-      // Get basic selector the value depends on
-      const selector = basics[depVal.dependsOn];
-
-      // Create table of values selector can be
-      const { dependsOn, ...table } = depVal as { [k: string]: unknown };
-
-      // Get the selector's picked value
-      const picked = table[selector];
-
-      if (picked !== undefined) {
-        resolved[k] = picked;
-      } else if ('default' in table) {
-        resolved[k] = table.default;
-      } else {
-        // eslint-disable-next-line max-len
-        console.warn(`[cypress.config] Could not resolve ${k}, dependsOn=${dependsOn}, selector=${String(selector)}`);
-        process.exit(1);
-      }
-    });
-  });
-
-  return resolved;
-};
-
-export default resolveDependents;

package/src/genConfiguration/helpers/splitEnv.ts

@@ -1,30 +0,0 @@
-// Import shared types
-import type GlobalsOrProfile from '../types/GlobalsOrProfile';
-import type DependentValue from '../types/DependentValue';
-import type SplitEnv from '../types/SplitEnv';
-
-/**
- * Split one map into basic and dependent values
- * @author Gardenia Liu
- * @param map to split
- * @returns split basic and dependent values map
- */
-const splitEnv = (map: GlobalsOrProfile): SplitEnv => {
-  const basic: GlobalsOrProfile = {};
-  const dependent: { [k: string]: DependentValue } = {};
-
-  Object.entries(map).forEach(([k, v]) => {
-    // If entry has dependsOn relationship, add it to dependent dictionary
-    if (typeof v === 'object' && 'dependsOn' in v) {
-      dependent[k] = v as DependentValue;
-    // Otherwise, add it to basic dictionary
-    } else {
-      basic[k] = v;
-    }
-  });
-
-  // Returns separated basic and dependent values
-  return { basic, dependent };
-};
-
-export default splitEnv;

package/src/genConfiguration/index.ts

@@ -1,83 +0,0 @@
-import path from 'path';
-
-// Import external libraries
-import { defineConfig } from 'cypress';
-import deepmerge from 'deepmerge';
-
-// Import helpers
-import splitEnv from './helpers/splitEnv';
-import resolveDependents from './helpers/resolveDependents';
-
-// Import types
-import type SplitEnv from './types/SplitEnv';
-import type GlobalsOrProfile from './types/GlobalsOrProfile';
-
-// Determine project directory
-const CWD = (process.env.INIT_CWD || process.env.PWD);
-
-/**
- * Generate Cypress configuration based on global credentials,
- * variables, resources, and profiles
- * @author Gardenia Liu
- * @author Gabe Abrams
- */
-const genConfiguration = () => {
-  // Define paths
-  const GLOBALS_PATH = path.join(CWD, '/cypress/globals');
-  const PROFILES_PATH = path.join(CWD, '/cypress/profiles');
-  
-  // Import global env var objects
-  const GlobalCredentials: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalCredentials'));
-  const GlobalResources: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalResources'));
-  const GlobalValues: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalValues'));
-
-  // Determine profile file name (default is stage)
-  const profileName = process.env.CYPRESS_PROFILE || 'stage';
-
-  // Load in chosen profile configuration
-  let profileModules: GlobalsOrProfile = {};
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const mod = require(path.join(PROFILES_PATH, `/${profileName}.Profile`));
-    profileModules = (mod?.default ?? mod ?? {}) as GlobalsOrProfile;
-  } catch (e) {
-    console.warn(`[cypress.config] Could not load profile '${profileName}.Profile'`, e);
-    process.exit(1);
-  }
-
-  // NOTE: Order matters (later overrides earlier)
-  const sources: GlobalsOrProfile[] = [GlobalCredentials, GlobalResources, GlobalValues, profileModules];
-
-  // Split all sources into basic and dependent
-  const splits: SplitEnv[] = sources.map(source => splitEnv(source));
-
-  // Extract basic and dependent values from splits
-  const basicValues = splits.map((s) => s.basic);
-  const dependentValues = splits.map((s) => s.dependent);
-
-  // Merge all of the basics
-  const basics: GlobalsOrProfile = deepmerge.all<GlobalsOrProfile>(basicValues);
-
-  // Resolve dependencies
-  const dependents: GlobalsOrProfile = resolveDependents(dependentValues, basics);
-
-  // Add basics, depends, and profileName into the final env
-  const finalEnv: GlobalsOrProfile = { 
-    ...basics,
-    ...dependents,
-    profileName,
-  };
-
-  const baseUrl = finalEnv.baseURL;
-
-  const config = defineConfig({
-    e2e: {
-      baseUrl,
-      env: finalEnv,
-    },
-  });
-
-  return config;
-};
-
-export default genConfiguration;

package/src/genConfiguration/types/DependentValue.ts

@@ -1,14 +0,0 @@
-/**
- * Value for a dependent entry
- * @author Gardenia Liu
- */
-type DependentValue = {
-  dependsOn: string,
-} & {
-  // Environment, global variables, profile values, etc.
-  [k: string]: any,
-  // Default value if the dependsOn value is not found
-  default?: any,
-};
-
-export default DependentValue;

package/src/genConfiguration/types/GlobalsOrProfile.ts

@@ -1,12 +0,0 @@
-/**
- * Object containing global variables, profile values, etc.
- * @author Gardenia Liu
- */
-type GlobalsOrProfile = {
-  // Base URL to prefix all paths with
-  baseURL?: string,
-  // Environment, global variables, profile values, etc.
-  [k: string]: any,
-};
-
-export default GlobalsOrProfile;

package/src/genConfiguration/types/SplitEnv.ts

@@ -1,18 +0,0 @@
-// Import shared types
-import type GlobalsOrProfile from './GlobalsOrProfile';
-import type DependentValue from './DependentValue';
-
-/**
- * Env type where basic and dependent entries are separated
- * @author Gardenia Liu
- */
-type SplitEnv = {
-  // Basic entries
-  basic: GlobalsOrProfile,
-  // Dependent entries
-  dependent: {
-    [k: string]: DependentValue,
-  },
-};
-
-export default SplitEnv;