feat: rename script target to custom

Author: atlj

docs/pages/build.md

@@ -188,17 +188,17 @@ Generates the [React Native Codegen](https://reactnative.dev/docs/the-new-archit
 
 You can ensure your Codegen generated scaffold code is stable through different React Native versions by shipping it with your library. You can find more in the [React Native Official Docs](https://reactnative.dev/docs/the-new-architecture/codegen-cli#including-generated-code-into-libraries).
 
-#### `script`
+#### `custom`
 
-Allows arbitrary scripts to be called during the build process. There is no guarantee when the script is going to be called or finished. This is useful to call code generators during the build process.
+Define a custom build target. This is useful to call code generators during the build process.
 
-##### `run`
+##### `script`
 
-`bob` will run the command passed in the `run` option. The build process will throw and exit if the `script` target is defined without the `run` option.
+`bob` will run the script passed in the `script` option. The build process **will throw and exit** if the `build` target is defined without this option.
 
 ##### `cwd`
 
-You can set the `cwd` (current working directory) option to specify where the command should be called from. This option accepts a path and will default to the path `build` was called from.
+You can set the `cwd` (current working directory) option to specify where the command should be called from. This option accepts **a relative path**, and it will default to the path `build` was called from.
 
 ##### `clean`
 

packages/react-native-builder-bob/src/index.ts

@@ -11,8 +11,8 @@ import buildCommonJS from './targets/commonjs';
 import buildModule from './targets/module';
 import buildTypescript from './targets/typescript';
 import buildCodegen from './targets/codegen';
+import customTarget from './targets/custom';
 import type { Options, Report, Target } from './types';
-import runScript from './targets/script';
 
 type ArgName = 'target';
 
@@ -585,8 +585,8 @@ async function buildTarget(
         report,
       });
       break;
-    case 'script':
-      await runScript({
+    case 'custom':
+      await customTarget({
         options: targetOptions,
         source: path.resolve(root, source),
         output: path.resolve(root, output, 'typescript'),

packages/react-native-builder-bob/src/targets/custom.ts

@@ -0,0 +1,64 @@
+import kleur from 'kleur';
+import path from 'path';
+import type { Input } from '../types';
+import { spawn } from '../utils/spawn';
+import dedent from 'dedent';
+import del from 'del';
+
+type Options = Input & {
+  options?: {
+    script?: string;
+    cwd?: string;
+    clean?: string;
+  }
+};
+
+const NO_SCRIPT_ERROR_MESSAGE = dedent(
+  `No script provided with the custom target.
+         Example: ${kleur.green('{["custom", { "script": "yarn generateTypes" }}')}`
+)
+
+export default async function customTarget({
+  options,
+  root,
+  report
+}: Options) {
+  if (options?.script === undefined) {
+    report.error(
+      NO_SCRIPT_ERROR_MESSAGE
+    )
+    process.exit(1)
+  }
+
+  const [scriptBinary, ...scriptParams] = options.script.split(" ");
+  if (scriptBinary === undefined) {
+    report.error(
+      NO_SCRIPT_ERROR_MESSAGE
+    )
+    process.exit(1)
+  }
+
+  let cwd = root
+  if (options.cwd) {
+    cwd = path.resolve(root, options.cwd)
+  }
+
+  if (options.clean) {
+    report.info(
+      `Cleaning up previous custom build at ${kleur.blue(path.relative(root, options.clean))}`
+    );
+
+    await del([path.resolve(cwd, options.clean)])
+  }
+
+
+  report.info(
+    `Running ${kleur.blue(options.script)} `
+  );
+
+  await spawn(scriptBinary, scriptParams, {
+    cwd,
+  })
+
+  report.success(`Ran ${kleur.blue(options.script)} succesfully`)
+}

packages/react-native-builder-bob/src/targets/script.ts

@@ -13,7 +13,7 @@ export type Input = {
   report: Report;
 };
 
-export type Target = 'commonjs' | 'module' | 'typescript' | 'codegen' | 'script';
+export type Target = 'commonjs' | 'module' | 'typescript' | 'codegen' | 'custom';
 
 export type Options = {
   source?: string;