feat: refactor, add exec

Author: tianyingchun

.changeset/wise-phones-remember.md

@@ -0,0 +1,5 @@
+---
+"@hyperse/exec-program": patch
+---
+
+refactor, add `exec`

.yarn/releases/yarn-4.2.2.cjs .yarn/releases/yarn-4.3.0.cjs.yarn/releases/yarn-4.2.2.cjs renamed to .yarn/releases/yarn-4.3.0.cjs

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.2.2.cjs
+yarnPath: .yarn/releases/yarn-4.3.0.cjs

.yarnrc.yml

@@ -31,6 +31,45 @@ npm i --save @hyperse/exec-program
 
 ### Usage
 
+### runTsScript
+
+```ts
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { runTsScript } from '@hyperse/exec-program';
+
+const getDirname = (url: string, ...paths: string[]) => {
+  return join(dirname(fileURLToPath(url)), ...paths);
+};
+
+const cliPath = getDirname(import.meta.url, './cli-test.ts');
+const { stderr, stdout } = await runTsScript(cliPath);
+console.log(stderr, stdout);
+```
+
+### exec
+
+import { exec } from '@hyperse/exec-program';
+
+```ts
+const { stdout, stderr } = await exec(
+  'npm',
+  ['i', '--no-save', '--no-package-lock', ...toInstall],
+  {
+    cwd: target.directory,
+    maxBuffer: TEN_MEGA_BYTE,
+    env: this.options.npmEnv,
+  }
+);
+```
+
+```ts
+await exec('npm', ['pack', directory], {
+  cwd: this.uniqueDir,
+  maxBuffer: TEN_MEGA_BYTE,
+});
+```
+
 #### unit test
 
 1. config `tsconfig.json`
@@ -83,7 +122,7 @@ const cliPath = getDirname(import.meta.url, './cli-test.ts');
 
 describe('test suites of exec program', () => {
   it('should correct invoke cli.ts', async () => {
-    const { stderr, stdout } = await runTsScript(cliPath, {});
+    const { stderr, stdout } = await runTsScript(cliPath);
     console.log(stderr, stdout);
     expect(stderr).toBe('');
     expect(stdout).toMatch(/cli.../);

README.md

@@ -76,7 +76,7 @@
     "cz-conventional-changelog": "3.3.0",
     "eslint": "^9.4.0",
     "husky": "9.0.11",
-    "lint-staged": "15.2.6",
+    "lint-staged": "15.2.7",
     "npm-run-all": "^4.1.5",
     "tsup": "^8.1.0",
     "typescript": "^5.4.5",
@@ -89,5 +89,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "yarn@4.2.2"
+  "packageManager": "yarn@4.3.0"
 }

package.json

@@ -0,0 +1,35 @@
+import { execa, Options } from 'execa';
+
+/**
+ * Execute a file with arguments and options
+ * @example
+ * ```ts
+ *  const { stdout, stderr } = await exec(
+ *    'npm',
+ *    ['i', '--no-save', '--no-package-lock', ...toInstall],
+ *    {
+ *      cwd: target.directory,
+ *      maxBuffer: TEN_MEGA_BYTE,
+ *      env: this.options.npmEnv,
+ *    }
+ *  );
+ *  ```
+ * @example
+ * ```ts
+ *  await exec('npm', ['pack', directory], {
+ *    cwd: this.uniqueDir,
+ *    maxBuffer: TEN_MEGA_BYTE,
+ *  });
+ * ```
+ * @param file - The program/script to execute, as a string or file URL
+ * @param args - Arguments to pass to `file` on execution.
+ * @param options - Options to pass to `execa`
+ * @returns A `ResultPromise` that is both:
+ */
+export function exec<T extends Options>(
+  file: string,
+  args?: readonly string[],
+  options?: T
+) {
+  return execa(file, args, options);
+}

src/exec.ts

@@ -1 +1,2 @@
+export * from './exec.js';
 export * from './runTsScript.js';

src/index.ts

@@ -9,15 +9,13 @@ import { execa } from 'execa';
  */
 export const runTsScript = <T extends Options>(
   program: string,
-  options: T,
-  ...args: string[]
+  args?: readonly string[],
+  options?: T
 ) => {
   const moduleArgs = [
     '--import',
     '@hyperse/ts-node-paths/register',
     '--no-warnings',
   ];
-  return execa('node', moduleArgs.concat(program, ...args), {
-    ...options,
-  });
+  return execa('node', moduleArgs.concat(program, ...(args || [])), options);
 };

src/runTsScript.ts

@@ -10,7 +10,7 @@ const cliPath = getDirname(import.meta.url, './cli-test.ts');
 
 describe('test suites of exec program', () => {
   it('should correct invoke cli.ts', async () => {
-    const { stderr, stdout } = await runTsScript(cliPath, {});
+    const { stderr, stdout } = await runTsScript(cliPath);
     console.log(stderr, stdout);
     expect(stderr).toBe('');
     expect(stdout).toMatch(/cli.../);

tests/exec.spec.ts

@@ -970,7 +970,7 @@ __metadata:
     eslint: "npm:^9.4.0"
     execa: "npm:^9.2.0"
     husky: "npm:9.0.11"
-    lint-staged: "npm:15.2.6"
+    lint-staged: "npm:15.2.7"
     npm-run-all: "npm:^4.1.5"
     tsup: "npm:^8.1.0"
     typescript: "npm:^5.4.5"
@@ -5447,9 +5447,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"lint-staged@npm:15.2.6":
-  version: 15.2.6
-  resolution: "lint-staged@npm:15.2.6"
+"lint-staged@npm:15.2.7":
+  version: 15.2.7
+  resolution: "lint-staged@npm:15.2.7"
   dependencies:
     chalk: "npm:~5.3.0"
     commander: "npm:~12.1.0"
@@ -5463,7 +5463,7 @@ __metadata:
     yaml: "npm:~2.4.2"
   bin:
     lint-staged: bin/lint-staged.js
-  checksum: 10/d2e7b610603ace80521d80afa7d355864a0f5f574aa2a2edbf5d96486e99ceeebb4d988e733c0b6ad8bfa899092f1c20db5cb02a0cc3e260919aeb92ef6f2d79
+  checksum: 10/7557bcf4e8dc0555f2c7e6a8ab6f5dfd7faaaed632a5d9e598768c86f786267ca216f8005068796a8118884d322a1c7f8f93e57c01b3e556475b77297ddad34f
   languageName: node
   linkType: hard