build: enhance dts gen

Author: antongolub

package.json

@@ -65,7 +65,7 @@
     "build": "npm run build:js && npm run build:dts",
     "build:check": "tsc",
     "build:js": "node scripts/build-js.mjs --format=cjs --hybrid --entry=src/*.ts && npm run build:vendor",
-    "build:vendor": "node scripts/build-js.mjs --format=cjs --entry='src/core-vendor.ts:src/vendor.ts' --bundle=all",
+    "build:vendor": "node scripts/build-js.mjs --format=cjs --entry=src/vendor-*.ts --bundle=all",
     "build:dts": "tsc --project tsconfig.prod.json && node scripts/build-dts.mjs",
     "pretest": "npm run build",
     "test": "npm run test:unit && npm run test:types && npm run test:license",
@@ -81,7 +81,7 @@
     "test:smoke:cjs": "node ./test/smoke/node.test.cjs",
     "test:smoke:mjs": "node ./test/smoke/node.test.mjs",
     "test:smoke:deno": "deno test ./test/smoke/deno.test.js --allow-read --allow-sys --allow-env --allow-run",
-    "coverage": "c8 -x build/deno.js -x build/vendor.cjs -x build/core-vendor.cjs -x build/esblib.cjs -x 'test/**' -x scripts --check-coverage npm 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 test",
     "version": "cat package.json | fx .version"
   },
   "optionalDependencies": {

scripts/build-dts.mjs

@@ -18,9 +18,15 @@ import fs from 'fs/promises'
 import { generateDtsBundle } from 'dts-bundle-generator'
 import glob from 'fast-glob'
 
-const entry = {
-  filePath: './src/vendor.ts',
-  outFile: './build/vendor.d.ts',
+const output = {
+  inlineDeclareExternals: true,
+  inlineDeclareGlobals: true,
+  sortNodes: false,
+  exportReferencedTypes: false, //args['export-referenced-types'],
+}
+const entries = [{
+  filePath: './src/vendor-extra.ts',
+  outFile: './build/vendor-extra.d.ts',
   libraries: {
     allowedTypesLibraries: ['node'], // args['external-types'],
     inlinedLibraries: [
@@ -30,30 +36,39 @@ const entry = {
       'fast-glob',
       '@types/jsonfile',
       'node-fetch-native',
-      'chalk',
+      // 'chalk',
       'globby',
-      '@types/minimist',
-      '@types/which',
-      'zurk',
-      '@webpod/ps',
+      // '@types/minimist',
+      // '@types/which',
+      // 'zurk',
+      // '@webpod/ps',
       '@webpod/ingrid',
       'depseek',
     ], // args['external-inlines'],
   },
-  output: {
-    inlineDeclareExternals: true,
-    inlineDeclareGlobals: true,
-    sortNodes: false,
-    exportReferencedTypes: false, //args['export-referenced-types'],
+  output,
+}, {
+  filePath: './src/vendor-core.ts',
+  outFile: './build/vendor-core.d.ts',
+  libraries: {
+    allowedTypesLibraries: ['node'], // args['external-types'],
+    inlinedLibraries: [
+      '@types/which',
+      '@webpod/ps',
+      '@webpod/ingrid',
+      'chalk',
+      'zurk',
+    ], // args['external-inlines'],
   },
-}
+  output,
+}]
 
 const compilationOptions = {
   preferredConfigPath: './tsconfig.prod.json', // args.project,
   followSymlinks: true,
 }
 
-let [result] = generateDtsBundle([entry], compilationOptions)
+const results = generateDtsBundle(entries, compilationOptions)
 
 // generateDtsBundle cannot handle the circular refs on types inlining, so we need to help it manually:
 /*
@@ -65,17 +80,23 @@ build/vendor.d.ts(167,7): error TS2456: Type alias 'FileSystemAdapter' circularl
 build/vendor.d.ts(197,48): error TS2694: Namespace 'FastGlob' has no exported member 'FastGlobOptions
  */
 
-result = result
-  .replace('type Options = Options;', 'export {Options};')
-  .replace('type Task = Task;', 'export {Task};')
-  .replace('type Pattern = Pattern;', 'export {Pattern};')
-  .replace('FastGlob.FastGlobOptions', 'FastGlob.Options')
-  .replace('type Entry =', 'export type Entry =')
+  .map(r => r
+    .replace('type Options = Options;', 'export {Options};')
+    .replace('type Task = Task;', 'export {Task};')
+    .replace('type Pattern = Pattern;', 'export {Pattern};')
+    .replace('FastGlob.FastGlobOptions', 'FastGlob.Options')
+    .replace('type Entry =', 'export type Entry =')
+  )
 
-await fs.writeFile(entry.outFile, result, 'utf8')
+for (const i in results) {
+  const entry = entries[i]
+  const result = results[i]
+
+  await fs.writeFile(entry.outFile, result, 'utf8')
+}
 
 // Replaces redundant triple-slash directives
-for (const dts of await glob(['build/**/*.d.ts', '!build/vendor.d.ts'])) {
+for (const dts of await glob(['build/**/*.d.ts', '!build/vendor.d.ts', '!build/core-vendor.d.ts'])) {
   const contents = (await fs.readFile(dts, 'utf8'))
     .split('\n')
     .filter((line) => !line.startsWith('/// <reference types'))

src/core.ts

@@ -34,7 +34,7 @@ import {
   type RequestInfo,
   type RequestInit,
   type TSpawnStore,
-} from './core-vendor.js'
+} from './vendor-core.js'
 import {
   type Duration,
   errnoMessage,

src/util.ts

@@ -15,7 +15,7 @@
 import os from 'node:os'
 import path from 'node:path'
 import fs from 'node:fs'
-import { chalk } from './core-vendor.js'
+import { chalk } from './vendor-core.js'
 
 export function tempdir(prefix = `zx-${randomId()}`) {
   const dirpath = path.join(os.tmpdir(), prefix)

src/core-vendor.ts src/vendor-core.ts

@@ -0,0 +1,68 @@
+// 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 { URL } from 'node:url'
+import {
+  convertPathToPattern,
+  globby,
+  globbySync,
+  globbyStream,
+  generateGlobTasksSync,
+  generateGlobTasks,
+  isGitIgnoredSync,
+  isGitIgnored,
+  isDynamicPattern,
+  type Options as GlobbyOptions,
+} from 'globby'
+import * as yaml from 'yaml'
+import * as _fs from 'fs-extra'
+import _createRequire from 'create-require'
+import { type fetch, AbortController } from 'node-fetch-native'
+
+export { fetch as nodeFetch } from 'node-fetch-native'
+
+global.AbortController = global.AbortController || AbortController
+
+export const createRequire = _createRequire as unknown as (
+  filename: string | URL
+) => NodeRequire
+
+export const globbyModule = {
+  convertPathToPattern,
+  globby,
+  globbySync,
+  globbyStream,
+  generateGlobTasksSync,
+  generateGlobTasks,
+  isGitIgnoredSync,
+  isGitIgnored,
+  isDynamicPattern,
+}
+
+export const glob = Object.assign(function globby(
+  patterns: string | readonly string[],
+  options?: GlobbyOptions
+) {
+  return globbyModule.globby(patterns, options)
+}, globbyModule) as (typeof globbyModule)['globby'] & typeof globbyModule
+
+export const YAML: {
+  parse(text: string): any
+  stringify(object: any): string
+} = yaml
+
+export const fs: typeof import('fs-extra') = _fs
+
+export { depseekSync as depseek } from 'depseek'
+export { default as minimist } from 'minimist'

src/vendor-extra.ts

@@ -12,59 +12,5 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { URL } from 'node:url'
-import {
-  convertPathToPattern,
-  globby,
-  globbySync,
-  globbyStream,
-  generateGlobTasksSync,
-  generateGlobTasks,
-  isGitIgnoredSync,
-  isGitIgnored,
-  isDynamicPattern,
-  type Options as GlobbyOptions,
-} from 'globby'
-import * as yaml from 'yaml'
-import * as _fs from 'fs-extra'
-import _createRequire from 'create-require'
-import { type fetch, AbortController } from 'node-fetch-native'
-
-export * from './core-vendor.js'
-
-export { fetch as nodeFetch } from 'node-fetch-native'
-
-global.AbortController = global.AbortController || AbortController
-
-export const createRequire = _createRequire as unknown as (
-  filename: string | URL
-) => NodeRequire
-
-export const globbyModule = {
-  convertPathToPattern,
-  globby,
-  globbySync,
-  globbyStream,
-  generateGlobTasksSync,
-  generateGlobTasks,
-  isGitIgnoredSync,
-  isGitIgnored,
-  isDynamicPattern,
-}
-
-export const glob = Object.assign(function globby(
-  patterns: string | readonly string[],
-  options?: GlobbyOptions
-) {
-  return globbyModule.globby(patterns, options)
-}, globbyModule) as (typeof globbyModule)['globby'] & typeof globbyModule
-
-export const YAML: {
-  parse(text: string): any
-  stringify(object: any): string
-} = yaml
-
-export const fs: typeof import('fs-extra') = _fs
-
-export { depseekSync as depseek } from 'depseek'
-export { default as minimist } from 'minimist'
+export * from './vendor-core.js'
+export * from './vendor-extra.js'