chore: rename setupSmth helpers to useSmth

Author: antongolub

src/core.ts

@@ -57,7 +57,6 @@ export interface Options {
   [processCwd]: string
   [syncExec]: boolean
   cwd?: string
-  cwdHook?: boolean
   ac?: AbortController
   input?: string | Buffer | Readable | ProcessOutput | ProcessPromise
   verbose: boolean
@@ -76,14 +75,19 @@ export interface Options {
 }
 
 const storage = new AsyncLocalStorage<Options>()
-const cwdHook: AsyncHook & { enabled?: boolean } = createHook({
+const cwdSyncHook: AsyncHook & { enabled?: boolean } = createHook({
   init: syncCwd,
   before: syncCwd,
   promiseResolve: syncCwd,
   after: syncCwd,
   destroy: syncCwd,
 })
 
+export function syncProcessCwd(flag: boolean = true) {
+  if (flag) cwdSyncHook.enable()
+  else cwdSyncHook.disable()
+}
+
 export const defaults: Options = {
   [processCwd]: process.cwd(),
   [syncExec]: false,
@@ -103,14 +107,14 @@ export const defaults: Options = {
 }
 const isWin = process.platform == 'win32'
 
-export function setupPowerShell() {
+export function usePowerShell() {
   $.shell = which.sync('powershell.exe')
   $.prefix = ''
   $.postfix = '; exit $LastExitCode'
   $.quote = quotePowerShell
 }
 
-export function setupBash() {
+export function useBash() {
   $.shell = which.sync('bash')
   $.prefix = 'set -euo pipefail;'
   $.quote = quote
@@ -170,30 +174,21 @@ export const $: Shell & Options = new Proxy<Shell & Options>(
   } as Shell & Options,
   {
     set(_, key, value) {
-      if (key === 'cwdHook') {
-        cwdHook.enabled = !!value
-        if (value) cwdHook.enable()
-        else cwdHook.disable()
-        return true
-      }
-
       const target = key in Function.prototype ? _ : getStore()
       Reflect.set(target, key === 'sync' ? syncExec : key, value)
 
       return true
     },
     get(_, key) {
       if (key === 'sync') return $({ sync: true })
-      if (key === 'cwdHook') return cwdHook.enabled
 
       const target = key in Function.prototype ? _ : getStore()
       return Reflect.get(target, key)
     },
   }
 )
-$.cwdHook = false
 try {
-  setupBash()
+  useBash()
 } catch (err) {}
 
 type Resolve = (out: ProcessOutput) => void

src/globals.ts

@@ -41,7 +41,8 @@ declare global {
   var quote: typeof _.quote
   var quotePowerShell: typeof _.quotePowerShell
   var retry: typeof _.retry
-  var setupPowerShell: typeof _.setupPowerShell
+  var usePowerShell: typeof _.usePowerShell
+  var useBash: typeof _.useBash
   var sleep: typeof _.sleep
   var spinner: typeof _.spinner
   var stdin: typeof _.stdin

test/core.test.js

@@ -232,14 +232,6 @@ describe('core', () => {
     assert.ok((await p) == 'foo')
   })
 
-  test('$.cwdHook is configurable', () => {
-    $.cwdHook = true
-    assert.equal($.cwdHook, true)
-
-    $.cwdHook = false
-    assert.equal($.cwdHook, false)
-  })
-
   test('cd() works with relative paths', async () => {
     let cwd = process.cwd()
     try {
@@ -271,8 +263,8 @@ describe('core', () => {
     }
   })
 
-  test('cd() does not affect parallel contexts ($.cwdHook enabled)', async () => {
-    $.cwdHook = true
+  test('cd() does not affect parallel contexts ($.cwdSyncHook enabled)', async () => {
+    syncProcessCwd()
     const cwd = process.cwd()
     try {
       fs.mkdirpSync('/tmp/zx-cd-parallel/one/two')
@@ -306,7 +298,7 @@ describe('core', () => {
     } finally {
       fs.rmSync('/tmp/zx-cd-parallel', { recursive: true })
       cd(cwd)
-      $.cwdHook = false
+      syncProcessCwd(false)
     }
   })
 

test/index.test.js

@@ -20,6 +20,9 @@ import {
   $,
   log,
   cd,
+  syncProcessCwd,
+  usePowerShell,
+  useBash,
   kill,
   ProcessOutput,
   ProcessPromise,
@@ -60,10 +63,13 @@ describe('index', () => {
     assert(ProcessOutput)
     assert(ProcessPromise)
     assert(cd)
+    assert(syncProcessCwd)
     assert(log)
     assert(kill)
     assert(defaults)
     assert(within)
+    assert(usePowerShell)
+    assert(useBash)
 
     // goods
     assert(argv)

test/package.test.js

@@ -17,8 +17,8 @@ import { test, describe, beforeEach, before, after } from 'node:test'
 import '../build/globals.js'
 
 describe('package', () => {
-  before(() => $.cwdHook = true)
-  after(() => $.cwdHook = false)
+  before(() => syncProcessCwd())
+  after(() => syncProcessCwd(false))
   beforeEach(async () => {
     const pack = await $`npm pack`
     await $`tar xf ${pack}`

test/smoke/win32.test.js

@@ -24,7 +24,7 @@ _describe('win32', () => {
     assert.match(p.stdout, /bash/)
 
     await within(async () => {
-      setupPowerShell()
+      usePowerShell()
       assert.match($.shell, /powershell/i)
       const p = await $`get-host`
       assert.match(p.stdout, /PowerShell/)
@@ -33,7 +33,7 @@ _describe('win32', () => {
 
   test('quotePowerShell works', async () => {
     await within(async () => {
-      setupPowerShell()
+      usePowerShell()
       const p = await $`echo ${`Windows 'rulez!'`}`
       assert.match(p.stdout, /Windows 'rulez!'/)
     })