fix(types): add missing minimist typings to dts bundle

relates #871

Author: antongolub

.size-limit.json

@@ -16,7 +16,7 @@
   {
     "name": "dts libdefs",
     "path": "build/*.d.ts",
-    "limit": "31 kB",
+    "limit": "34 kB",
     "brotli": false,
     "gzip": false
   },

package-lock.json

@@ -68,6 +68,7 @@
     "build:dts": "tsc --project tsconfig.prod.json && node scripts/build-dts.mjs",
     "pretest": "npm run build",
     "test": "npm run test:size && npm run fmt:check && npm run test:unit && npm run test:types && npm run test:license",
+    "test:it": "node ./test/it/build.test.js",
     "test:unit": "node ./test/all.test.js",
     "test:coverage": "c8 -x build/deno.js -x build/vendor-extra.cjs -x build/vendor-core.cjs -x build/esblib.cjs -x 'test/**' -x scripts --check-coverage npm run test:unit",
     "test:circular": "madge --circular src/*",

package.json

@@ -39,7 +39,7 @@ const entries = [
         'node-fetch-native',
         // 'chalk',
         'globby',
-        // '@types/minimist',
+        '@types/minimist',
         // '@types/which',
         // 'zurk',
         // '@webpod/ps',

scripts/build-dts.mjs

@@ -15,6 +15,7 @@
 import assert from 'node:assert'
 import { expectType } from 'tsd'
 import 'zx/globals'
+import { ParsedArgs } from 'minimist'
 
 let p = $`cmd`
 assert(p instanceof ProcessPromise)
@@ -26,3 +27,5 @@ expectType<ProcessOutput>(o)
 
 expectType<string>(quote('foo'))
 expectType<string>(quotePowerShell('foo'))
+
+expectType<ParsedArgs>(minimist(['--foo', 'bar']))

test-d/globals.test-d.ts

@@ -0,0 +1,76 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { tempdir, $, path, fs } from '../../build/index.js'
+import assert from 'node:assert'
+import { describe, before, after, it } from 'node:test'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+const root = path.resolve(__dirname, '../../')
+
+describe('npm artifact', () => {
+  let tmp
+  let zxdir
+  let t$
+
+  const pkgJson = {
+    name: 'zx-test',
+    dependencies: {
+      typescript: '^5',
+      '@types/node': '*',
+      '@types/fs-extra': '*'
+    }
+  }
+
+  before(async () => {
+    tmp = tempdir()
+    t$ = $({cwd: tmp, quiet: true})
+    zxdir = path.resolve(tmp, 'node_modules/zx')
+
+    await fs.outputJSON(path.resolve(tmp, 'package.json'), pkgJson)
+    await t$`npm i`
+    // `file:<path>` dep mounts `node_modules` too, so we use cloning here
+    await fs.copy(path.resolve(root, 'package.json'), path.resolve(zxdir, 'package.json'))
+    await fs.copy(path.resolve(root, 'build'), path.resolve(zxdir, 'build'))
+  })
+
+  after(() => fs.remove(tmp))
+
+  it('looks buildable with tsc', async () => {
+    const indexTs = `import {$} from 'zx'
+(async () => {
+  await $({verbose: true, stdio: 'pipe'})\`echo hello\`
+})()
+`
+    const tsconfig = {
+      compilerOptions: {
+        module: 'commonjs',
+        target: 'esnext',
+        outDir: 'build-tsc',
+        rootDir: 'src',
+        declaration: true,
+        declarationMap: false,
+        esModuleInterop: true,
+      },
+      include: ['src'],
+    }
+
+    await fs.outputJSON(path.resolve(tmp, 'tsconfig.json'), tsconfig)
+    await fs.outputFile(path.resolve(tmp, 'src/index.ts'), indexTs)
+    await t$`tsc`
+    const result = await t$`node build-tsc/index.js`.text()
+
+    assert.strictEqual(result, '$ echo hello\nhello\n')
+  })
+})