.github/codeql/codeql-config.yml

@@ -0,0 +1,11 @@
+paths:
+  - .github
+  - docs
+  - examples
+  - man
+  - src
+  - scripts
+  - test
+  - test-d
+paths-ignore:
+  - build

.github/workflows/codeql.yml

@@ -8,6 +8,8 @@ on:
   schedule:
     - cron: '28 6 * * 3'
 
+permissions: {}
+
 jobs:
   analyze:
     name: Analyze (${{ matrix.language }})
@@ -39,6 +41,7 @@ jobs:
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3
         with:
+          config-file: ./.github/codeql/codeql-config.yml
           languages: ${{ matrix.language }}
           build-mode: ${{ matrix.build-mode }}
 

.github/workflows/dev-publish.yml

@@ -3,6 +3,8 @@ name: Dev Publish
 on:
   workflow_dispatch:
 
+permissions: {}
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/docs.yml

@@ -8,6 +8,8 @@ concurrency:
   group: 'pages'
   cancel-in-progress: false
 
+permissions: {}
+
 jobs:
   deploy:
     permissions:

.github/workflows/npm-publish.yml

@@ -5,6 +5,8 @@ on:
   release:
     types: [created]
 
+permissions: {}
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/osv.yml

@@ -11,6 +11,8 @@
 
 name: OSV-Scanner
 
+permissions: {}
+
 on:
   pull_request:
     branches: ['main']

.github/workflows/zizmor.yml

@@ -0,0 +1,30 @@
+name: Zizmor
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['**']
+
+permissions: {}
+
+jobs:
+  zizmor:
+    name: zizmor
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      actions: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: false
+
+      - name: Run zizmor
+        run: uvx zizmor@1.5.0 .github/workflows -v -p --min-severity=medium

.gitignore

@@ -5,4 +5,5 @@ package/
 reports/
 docs/.vitepress/cache/
 yarn.lock
+pnpm-lock.yaml
 temp

.size-limit.json

@@ -9,14 +9,14 @@
   {
     "name": "zx/index",
     "path": "build/*.{js,cjs}",
-    "limit": "812.1 kB",
+    "limit": "812 kB",
     "brotli": false,
     "gzip": false
   },
   {
     "name": "dts libdefs",
     "path": "build/*.d.ts",
-    "limit": "39 kB",
+    "limit": "39.3 kB",
     "brotli": false,
     "gzip": false
   },
@@ -30,7 +30,7 @@
   {
     "name": "all",
     "path": "build/*",
-    "limit": "851 kB",
+    "limit": "851.1 kB",
     "brotli": false,
     "gzip": false
   }

docs/.vitepress/config.mts

@@ -75,6 +75,7 @@ export default defineConfig({
           link: '/faq',
           items: [
             { text: 'Quotes', link: '/quotes' },
+            { text: 'Shell', link: '/shell' },
             { text: 'TypeScript', link: '/typescript' },
             { text: 'Markdown Scripts', link: '/markdown-scripts' },
             { text: 'Known Issues', link: '/known-issues' },

docs/configuration.md

@@ -84,7 +84,7 @@ all `$` processes use `process.cwd()` by default (same as `spawn` behavior).
 
 ## `$.log`
 
-Specifies a [logging function](src/core.ts).
+Specifies a [logging function](src/log.ts).
 
 ```ts
 import {LogEntry, log} from 'zx/core'
@@ -101,6 +101,22 @@ $.log = (entry: LogEntry) => {
 }
 ```
 
+Log mostly acts like a debugger, so by default it uses `process.error` for output.
+Set `log.output` to change the stream.
+
+```ts
+$.log.output = process.stdout
+```
+
+Set `log.formatters` to customize each log entry kind printing:
+
+```ts
+$.log.formatters = {
+  cmd: (entry: LogEntry) => `CMD: ${entry.cmd}`,
+  fetch: (entry: LogEntry) => `FETCH: ${entry.url}`
+}
+```
+
 ## `$.timeout`
 
 Specifies a timeout for the command execution.

docs/shell.md

@@ -0,0 +1,23 @@
+# Shell
+
+zx is not aimed to replace the shell, but to provide a more convenient way to use it through JavaScript enhancements. It supplements the shell with a more powerful and expressive language, so some kind of bash/zsh is still required.
+
+zx provides several functions to help with setup:
+
+* [`useBash`](./api#usebash) switches to bash
+* [`usePowerShell`](./api#usepowershell) - PowerShell
+* [`usePwsh`](./api#usepwsh) - pwsh (PowerShell v7+)
+
+You can also set the shell directly via [JS API](./setup#bash), [CLI flags](./cli#shell) or [envars](./cli#environment-variables):
+
+```js
+$.shell = '/bin/zsh'
+```
+
+```bash
+zx --shell /bin/zsh script.js
+```
+
+```bash
+ZX_SHELL=/bin/zsh zx script.js
+```