fix(exec): Run scripts from inside scripts dir (#59)

Author: Tobbe

.github/workflows/ci.yml

@@ -438,9 +438,13 @@ jobs:
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
 
       - name: Run `rw info`
-        run: yarn rw info
+        run: yarn rw info | tr -d '\n' | grep "npmPackages:.*@redmix/core:"
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
 
+      - name: Run in /scripts `rw info`
+        run: yarn rw info | tr -d '\n' | grep "npmPackages:.*@redmix/core:"
+        working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}/scripts
+
       - name: Run `rw lint`
         run: yarn rw lint ./api/src --fix
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
@@ -465,6 +469,17 @@ jobs:
         run: yarn rw g script testScript && yarn rw exec testScript
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
 
+      - name: Nested script | Run "rw exec"
+        # Using -f to overwrite script that already exists in the test-project
+        run: yarn rw g script -f i/am/nested && yarn rw exec i/am/nested
+        working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}
+
+      - name: Nested script | Run in /scripts "rw exec"
+        # This is probably stretching the definition of "smoke test" a bit too
+        # much. But we don't have a better place to run a test like this
+        run: yarn rw g script i/am/nested/too && yarn rw exec i/am/nested/too | grep "Executing script with args"
+        working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}/scripts/i/am
+
       - name: Run "prisma generate"
         run: yarn rw prisma generate
         working-directory: ${{ steps.set-up-test-project.outputs.test-project-path }}

__fixtures__/test-project/scripts/i/am/nested.ts

@@ -0,0 +1,15 @@
+// Append api/* to import from api and web/* to import from web
+
+// To access your database uncomment the line below
+// import { db } from 'api/src/lib/db'
+
+interface Args {
+  _: string[]
+  [key: string]: unknown
+}
+
+export default async ({ args }: Args) => {
+  // Your script here...
+  console.log(':: Executing script with args ::')
+  console.log(args)
+}

packages/cli/src/__tests__/cwd.test.js

@@ -6,9 +6,6 @@ import { describe, it, expect } from 'vitest'
 const BASE_DIR = path.resolve(import.meta.dirname, '..', '..', '..', '..')
 const CLI = path.join(BASE_DIR, 'packages', 'cli', 'dist', 'index.js')
 
-console.log('BASE_DIR:', BASE_DIR)
-console.log('CLI:', CLI)
-
 function rw(args, options) {
   const { status, stdout, stderr } = spawnSync('node', [CLI, ...args], {
     cwd: BASE_DIR,

packages/cli/src/index.js

@@ -101,6 +101,10 @@ try {
 
 process.env.RWJS_CWD = cwd
 
+if (process.cwd() !== cwd) {
+  process.chdir(cwd)
+}
+
 // Load .env.* files.
 //
 // This should be done as early as possible, and the earliest we can do it is after setting `cwd`.

packages/telemetry/src/sendTelemetry.ts

@@ -118,7 +118,7 @@ const getInfo = async (presets: Args = {}) => {
     npmVersion: info.Binaries?.npm?.version,
     vsCodeVersion: info.IDEs?.VSCode?.version,
     redwoodVersion:
-      presets.redwoodVersion || info.npmPackages['@redmix/core']?.installed,
+      presets.redwoodVersion || info.npmPackages?.['@redmix/core']?.installed,
     system: `${cpu.physicalCores}.${Math.round(mem.total / 1073741824)}`,
     webBundler: 'vite', // Hardcoded as this is now the only supported bundler
     experiments,

tasks/test-project/rebuild-test-project-fixture.ts

@@ -415,7 +415,7 @@ async function runCommand() {
   await tuiTask({
     step: 9,
     title: 'Add scripts',
-    task: () => {
+    task: async () => {
       const nestedPath = path.join(OUTPUT_PROJECT_PATH, 'scripts', 'one', 'two')
 
       fs.mkdirSync(nestedPath, { recursive: true })
@@ -425,6 +425,57 @@ async function runCommand() {
           "  console.log('Hello from myNestedScript.ts')\n" +
           '}\n\n',
       )
+
+      await exec(
+        'yarn rw g script i/am/nested',
+        [],
+        getExecaOptions(OUTPUT_PROJECT_PATH),
+      )
+
+      // Verify that the scripts are added and included in the list of
+      // available scripts
+      const list = await exec(
+        'yarn rw exec',
+        [],
+        getExecaOptions(OUTPUT_PROJECT_PATH),
+      )
+
+      if (
+        !list.stdout.includes('seed') ||
+        !list.stdout.includes('i/am/nested') ||
+        !list.stdout.includes('one/two/myNestedScript')
+      ) {
+        console.error('yarn rw exec output', list.stdout, list.stderr)
+
+        throw new Error('Scripts not included in list')
+      }
+
+      // Verify that the scripts can be executed
+      const runFromRoot = await exec(
+        'yarn rw exec one/two/myNestedScript',
+        [],
+        getExecaOptions(OUTPUT_PROJECT_PATH),
+      )
+
+      if (!runFromRoot.stdout.includes('Hello from myNestedScript')) {
+        console.error('`yarn rw exec one/two/myNestedScript` output')
+        console.error(runFromRoot.stdout, runFromRoot.stderr)
+
+        throw new Error('Script not executed successfully')
+      }
+
+      const runFromScripts = await exec(
+        'yarn rw exec one/two/myNestedScript',
+        [],
+        getExecaOptions(path.join(OUTPUT_PROJECT_PATH, 'scripts', 'one')),
+      )
+
+      if (!runFromScripts.stdout.includes('Hello from myNestedScript')) {
+        console.error('`yarn rw exec one/two/myNestedScript` output')
+        console.error(runFromRoot.stdout, runFromRoot.stderr)
+
+        throw new Error('Script not executed successfully')
+      }
     },
   })