feat: add detox recipe

readme.md

@@ -71,6 +71,10 @@ The following are **feature flags** that can be used in silent mode (they are ig
     <td style="vertical-align: middle;">--eas-update</td>
     <td style="vertical-align: middle;">Generate EAS Update and preview workflow to run on every PR.</td>
   </tr>
+  <tr>
+    <td style="vertical-align: middle;">--detox</td>
+    <td style="vertical-align: middle;">Generate workflow to run Detox e2e tests on every PR.</td>
+  </tr>
 </table>
 
 ## 🔐 Repository secrets
@@ -87,6 +91,14 @@ as you will always be prompted to create secrets if necessary. The following tab
     <td style="vertical-align: middle;">EXPO_TOKEN</td>
     <td style="vertical-align: middle;">Used for authentication in workflows using your Expo account. Learn more at <a href=https://docs.expo.dev/eas-update/github-actions>Expo with GitHub actions</a>.</td>
   </tr>
+  <tr>
+    <td style="vertical-align: middle;">GH_TOKEN</td>
+    <td style="vertical-align: middle;">
+      Used by workflows reading status of other GitHub actions. You can learn how to generate the token at 
+      <a href=https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens>Managing your personal access tokens</a>. 
+      Make sure that your generated token has <ins>read access to actions</ins>. 
+    </td>
+  </tr>
 </table>
 
 ## 💬 Your feedback

src/commands/react-native-ci-cli.ts

@@ -5,6 +5,7 @@ import jest from '../recipes/jest'
 import typescriptCheck from '../recipes/typescript'
 import prettierCheck from '../recipes/prettier'
 import easUpdate from '../recipes/eas-update'
+import detox from '../recipes/detox'
 import isGitDirty from 'is-git-dirty'
 import sequentialPromiseMap from '../utils/sequentialPromiseMap'
 import { CycliToolbox, ProjectContext } from '../types'
@@ -46,13 +47,15 @@ const runReactNativeCiCli = async (toolbox: CycliToolbox) => {
   const typescriptExecutor = await typescriptCheck.run(toolbox, context)
   const prettierExecutor = await prettierCheck.run(toolbox, context)
   const easUpdateExecutor = await easUpdate.run(toolbox, context)
+  const detoxExecutor = await detox.run(toolbox, context)
 
   const executors = [
     lintExecutor,
     jestExecutor,
     typescriptExecutor,
     prettierExecutor,
     easUpdateExecutor,
+    detoxExecutor,
   ].filter((executor) => executor != null)
 
   if (executors.length === 0) {
@@ -88,6 +91,7 @@ const getFeatureOptions = (): Option[] => {
     typescriptCheck.meta,
     prettierCheck.meta,
     easUpdate.meta,
+    detox.meta,
   ].map((meta) => ({
     flag: meta.flag,
     description: meta.description,

src/extensions/dependencies.ts

@@ -1,54 +1,30 @@
 import { CycliToolbox, ProjectContext } from '../types'
 
 module.exports = (toolbox: CycliToolbox) => {
-  const { packageManager, semver } = toolbox
+  const { packageManager } = toolbox
 
-  const getSemver = (name: string): string | undefined => {
-    return toolbox.projectConfig.packageJson().dependencies?.[name]
-  }
-
-  const getSemverDev = (name: string): string | undefined => {
-    return toolbox.projectConfig.packageJson().devDependencies?.[name]
-  }
-
-  const exists = (name: string): boolean => !!getSemver(name)
-
-  const existsDev = (name: string): boolean => !!getSemverDev(name)
-
-  const isSatisfied = (name: string, version: string): boolean => {
-    const currentVersion = getSemver(name)
-    return (
-      !!currentVersion &&
-      (version === '' || semver.satisfies(currentVersion, version))
-    )
-  }
+  const exists = (name: string): boolean =>
+    Boolean(toolbox.projectConfig.packageJson().dependencies?.[name])
 
-  const isSatisfiedDev = (name: string, version: string): boolean => {
-    const currentVersion = getSemverDev(name)
-    return (
-      !!currentVersion &&
-      (version === '' || semver.satisfies(currentVersion, version))
-    )
-  }
+  const existsDev = (name: string): boolean =>
+    Boolean(toolbox.projectConfig.packageJson().devDependencies?.[name])
 
-  const add = async (name: string, context: ProjectContext, version = '') => {
-    if (existsDev(name)) {
-      toolbox.interactive.warning(
-        `Moving ${name} from "devDependencies" to "dependencies".`
-      )
-
-      const spinner = toolbox.interactive.spin(
-        `🗑️ Removing ${name} from "devDependencies"...`
-      )
-      await packageManager.remove(name, { dev: true })
-      spinner.stop()
+  const add = async (
+    name: string,
+    context: ProjectContext,
+    {
+      version = '',
+      skipInstalledCheck = false,
+    }: { version?: string; skipInstalledCheck?: boolean } = {
+      version: '',
+      skipInstalledCheck: false,
     }
-
+  ) => {
     const fullName = version ? [name, version].join('@') : name
 
-    if (isSatisfied(name, version)) {
+    if (!skipInstalledCheck && exists(name)) {
       toolbox.interactive.step(
-        `Dependency ${fullName} is already satisfied, skipping adding dependency.`
+        `Dependency ${name} is already installed, skipping adding dependency.`
       )
       return
     }
@@ -68,39 +44,44 @@ module.exports = (toolbox: CycliToolbox) => {
   const addDev = async (
     name: string,
     context: ProjectContext,
-    version = ''
+    {
+      version = '',
+      skipInstalledCheck = false,
+    }: { version?: string; skipInstalledCheck?: boolean } = {
+      version: '',
+      skipInstalledCheck: false,
+    }
   ) => {
     if (exists(name)) {
       toolbox.interactive.warning(
         `Detected package ${name} in "dependencies", but shouldn't it be in "devDependencies"?`
       )
-      add(name, context, version)
+      add(name, context, { version, skipInstalledCheck })
       return
     }
 
     const fullName = version ? [name, version].join('@') : name
 
-    if (isSatisfiedDev(name, version)) {
+    if (!skipInstalledCheck && existsDev(name)) {
       toolbox.interactive.step(
-        `Dev dependency ${fullName} is already satisfied, skipping adding dependency.`
-      )
-    } else {
-      const spinner = toolbox.interactive.spin(
-        `📦 Installing ${fullName} as devDependency...`
+        `Dev dependency ${name} is already installed, skipping adding dependency.`
       )
-      await packageManager.add(fullName, {
-        dev: true,
-        force: context.packageManager,
-      })
-      spinner.stop()
+      return
     }
 
+    const spinner = toolbox.interactive.spin(
+      `📦 Installing ${fullName} as devDependency...`
+    )
+    await packageManager.add(fullName, {
+      dev: true,
+      force: context.packageManager,
+    })
+    spinner.stop()
+
     toolbox.interactive.step(`Installed ${fullName} as devDependency.`)
   }
 
   toolbox.dependencies = {
-    isSatisfied,
-    isSatisfiedDev,
     exists,
     existsDev,
     add,
@@ -110,19 +91,23 @@ module.exports = (toolbox: CycliToolbox) => {
 
 export interface DependenciesExtension {
   dependencies: {
-    isSatisfied: (name: string, version: string) => boolean
-    isSatisfiedDev: (name: string, version: string) => boolean
     exists: (name: string) => boolean
     existsDev: (name: string) => boolean
     add: (
       name: string,
       context: ProjectContext,
-      version?: string
+      options?: {
+        version?: string
+        skipInstalledCheck?: boolean
+      }
     ) => Promise<void>
     addDev: (
       name: string,
       context: ProjectContext,
-      version?: string
+      options?: {
+        version?: string
+        skipInstalledCheck?: boolean
+      }
     ) => Promise<void>
   }
 }

src/extensions/projectConfig.ts

@@ -1,31 +1,37 @@
-import { CycliToolbox, PackageJson } from '../types'
+import { AppJson, CycliToolbox, PackageJson } from '../types'
 
 module.exports = (toolbox: CycliToolbox) => {
   const { filesystem } = toolbox
 
   const packageJson = (): PackageJson => {
     if (!filesystem.exists('package.json')) {
       throw Error(
-        '❗ No package.json found in current directory. Are you sure you are in a project directory?'
+        'No package.json found in current directory. Are you sure you are in a project directory?'
       )
     }
 
     return filesystem.read('package.json', 'json')
   }
 
+  const appJson = (): AppJson | undefined => {
+    return filesystem.read('app.json', 'json')
+  }
+
   const getName = (): string => {
     return packageJson().name
   }
 
   toolbox.projectConfig = {
     packageJson,
+    appJson,
     getName,
   }
 }
 
 export interface ProjectConfigExtension {
   projectConfig: {
     packageJson: () => PackageJson
+    appJson: () => AppJson | undefined
     getName: () => string
   }
 }

src/extensions/projectContext.ts

@@ -44,7 +44,7 @@ module.exports = (toolbox: CycliToolbox) => {
 
     if (packageJson.workspaces) {
       throw Error(
-        '❗ The current directory is workspace root directory. Please run the script again from selected package root directory.'
+        'The current directory is workspace root directory. Please run the script again from selected package root directory.'
       )
     }
 
@@ -61,6 +61,9 @@ module.exports = (toolbox: CycliToolbox) => {
     const absFromRepoRoot = (...paths: string[]): string =>
       join(repoRoot, ...paths)
 
+    const expoConfigJson = toolbox.filesystem.read('app.json', 'json')
+    const iOSAppName = expoConfigJson?.expo?.name.replaceAll('-', '')
+
     return {
       packageManager: getPackageManager(repoRoot),
       path: {
@@ -69,6 +72,7 @@ module.exports = (toolbox: CycliToolbox) => {
         relFromRepoRoot,
         absFromRepoRoot,
       },
+      iOSAppName,
       selectedOptions: [],
     }
   }

src/extensions/scripts.ts

@@ -6,6 +6,12 @@ module.exports = (toolbox: CycliToolbox) => {
   const add = async (name: string, command: string) => {
     await patching.update('package.json', (config) => {
       if (config.scripts[name]) {
+        toolbox.interactive.warning(
+          [
+            `Skipping attempt to add script "${name}": "${command}" to package.json as script ${name} already exists.`,
+            `Consider updating it to make generated workflows work properly.`,
+          ].join(' ')
+        )
         return config
       }
 

src/extensions/workflows.ts

@@ -15,6 +15,12 @@ module.exports = (toolbox: CycliToolbox) => {
     return `${toolbox.projectConfig.getName()}-${workflowBasename}.yml`
   }
 
+  const formatWorkflowString = (workflowString: string): string => {
+    return workflowString
+      .trimStart() // Remove white characters from beginning
+      .replace(/\n([ ]*\n[ ]*)+\n/g, '\n\n') // Replace >=3 consecutive empty lines (possibly containing spaces) with two endlines
+  }
+
   const generate = async (
     template: string,
     context: ProjectContext,
@@ -40,7 +46,7 @@ module.exports = (toolbox: CycliToolbox) => {
       workflowFileName
     )
 
-    toolbox.filesystem.write(target, workflowString.trimStart())
+    toolbox.filesystem.write(target, formatWorkflowString(workflowString))
 
     toolbox.interactive.step(`Created ${workflowFileName} workflow file.`)
   }