feat: auto build bin field

.gitignore

@@ -5,4 +5,4 @@ dist
 .yalc
 yalc.lock
 test/**/*.js.map
-.DS_Store
+.DS_Store

src/build-config.ts

@@ -10,7 +10,7 @@ import type {
 import type { InputOptions, OutputOptions, Plugin } from 'rollup'
 import { type TypescriptOptions } from './typescript'
 
-import { resolve, dirname } from 'path'
+import { resolve, dirname, extname, join } from 'path'
 import { wasm } from '@rollup/plugin-wasm'
 import { swc } from 'rollup-plugin-swc3'
 import commonjs from '@rollup/plugin-commonjs'
@@ -38,7 +38,9 @@ import {
 import {
   availableExportConventions,
   availableESExtensionsRegex,
+  dtsExtensions,
 } from './constants'
+import { logger } from './logger'
 
 const swcMinifyOptions = {
   compress: true,
@@ -375,6 +377,65 @@ export async function buildEntryConfig(
     configs.push(...buildConfigs)
   })
 
+  const binaryExports = pkg.bin
+  if (binaryExports) {
+    // binDistPaths: [ [ 'bin1', './dist/bin1.js'], [ 'bin2', './dist/bin2.js'] ]
+    const binPairs = typeof binaryExports === 'string'
+      ? [['bin', binaryExports]]
+      : Object.keys(binaryExports)
+        .map((key) => [join('bin', key), (binaryExports)[key]])
+
+    const isESModule = pkg.type === 'module'
+    const binExportPaths = binPairs.reduce((acc, [binName, binDistPath]) => {
+      const ext = extname(binDistPath).slice(1) as keyof typeof dtsExtensions
+      const isCjsExt = ext === 'cjs'
+      const isEsmExt = ext === 'mjs'
+
+      const exportType = isEsmExt
+        ? 'import'
+        : isCjsExt
+        ? 'require'
+        : isESModule
+        ? 'import'
+        : 'require'
+
+      acc[binName] = {
+        [exportType]: binDistPath,
+      }
+      return acc
+    }, {} as ExportPaths)
+
+    for (const [binName] of binPairs) {
+      const source = await getSourcePathFromExportPath(
+        cwd,
+        binName,
+        '$binary'
+      )
+
+      if (!source) {
+        logger.warn(`Cannot find source file for ${binName}`)
+        continue
+      }
+
+      const binEntryPath = await resolveSourceFile(cwd, source)
+      const binEntryConfig = buildConfig(
+        binEntryPath,
+        pkg,
+        binExportPaths,
+        bundleConfig,
+        {
+          source: binEntryPath,
+          name: binName,
+          export: binExportPaths[binName],
+        },
+        cwd,
+        tsOptions,
+        dts,
+      )
+      configs.push(binEntryConfig)
+    }
+  }
+
   return (await Promise.all(configs)).filter(nonNullable)
 }
 

src/bundle.ts

@@ -68,6 +68,7 @@ async function bundle(
   )
   // const exportPathsLength = Object.keys(exportPaths).length
   const isMultiEntries = hasMultiEntryExport(exportPaths) // exportPathsLength > 1
+  const hasBin = Boolean(pkg.bin)
 
   const tsConfig = await resolveTsConfig(cwd)
   const hasTsConfig = Boolean(tsConfig?.tsConfigPath)
@@ -135,7 +136,8 @@ async function bundle(
     ? (await fileExists(entryPath)) && (await fs.stat(entryPath)).isFile()
     : false
 
-  if (!hasSpecifiedEntryFile && !isMultiEntries) {
+  const hasNoEntry = !hasSpecifiedEntryFile && !isMultiEntries && !hasBin
+  if (hasNoEntry) {
     const err = new Error(`Entry file \`${entryPath}\` is not existed`)
     err.name = 'NOT_EXISTED'
     return Promise.reject(err)

src/constants.ts

@@ -17,3 +17,9 @@ export const availableESExtensionsRegex = /\.(m|c)?[jt]sx?$/
 export const dtsExtensionRegex = /\.d\.(m|c)?ts$/
 
 export const SRC = 'src'
+
+export const dtsExtensions = {
+  js: '.d.ts',
+  cjs: '.d.cts',
+  mjs: '.d.mts',
+}

src/exports.ts

@@ -7,6 +7,7 @@ import type {
   ParsedExportCondition,
 } from './types'
 import { exit, filenameWithoutExtension, hasCjsExtension } from './utils'
+import { dtsExtensions } from './constants'
 
 export function getTypings(pkg: PackageMetadata) {
   return pkg.types || pkg.typings
@@ -235,14 +236,9 @@ export const getExportTypeDist = (
       existed.add(typeFile)
       continue
     }
-    const ext = extname(filePath).slice(1)
-    const dtsExtentions: Record<string, string> = {
-      js: '.d.ts',
-      cjs: '.d.cts',
-      mjs: '.d.mts',
-    }
+    const ext = extname(filePath).slice(1) as keyof typeof dtsExtensions
     const typeFile = getDistPath(
-      `${filenameWithoutExtension(filePath) || ''}${dtsExtentions[ext]}`,
+      `${filenameWithoutExtension(filePath) || ''}${dtsExtensions[ext]}`,
       cwd,
     )
     if (existed.has(typeFile)) {
@@ -314,7 +310,7 @@ export function getExportConditionDist(
     dist.push({ format, file: distFile })
   }
 
-  if (dist.length === 0) {
+  if (dist.length === 0 && !pkg.bin) {
     // TODO: Deprecate this warning and behavior in v3
     console.error(
       `Doesn't fin any exports in ${pkg.name}, using default dist path dist/index.js`,

src/types.ts

@@ -43,6 +43,7 @@ type BundleConfig = {
 type PackageMetadata = {
   name?: string
   main?: string
+  bin?: string | Record<string, string>
   module?: string
   type?: 'commonjs' | 'module'
   dependencies?: Record<string, string>

src/utils.ts

@@ -67,7 +67,7 @@ export function resolveSourceFile(cwd: string, filename: string) {
   return path.resolve(cwd, SRC, filename)
 }
 
-async function findSourceEntryFile(
+export async function findSourceEntryFile(
   cwd: string,
   exportPath: string,
   exportTypeSuffix: string | null,
@@ -109,7 +109,8 @@ export async function getSourcePathFromExportPath(
     if (exportPath === '.') exportPath = './index'
 
     // Find convention-based source file for specific export types
-    if (availableExportConventions.includes(exportType)) {
+    // $binary represents `pkg.bin`
+    if (availableExportConventions.includes(exportType) && exportType !== '$binary') {
       const filename = await findSourceEntryFile(
         cwd,
         exportPath,

test/integration.test.ts

@@ -1,5 +1,4 @@
 import fs from 'fs/promises'
-import fsSync from 'fs'
 import { execSync, fork } from 'child_process'
 import { resolve, join } from 'path'
 import { stripANSIColor, existsFile, assertFilesContent } from './testing-utils'
@@ -228,10 +227,7 @@ const testCases: {
     name: 'ts-incremental',
     args: [],
     async expected(dir) {
-      const distFiles = [
-        './dist/index.js',
-        './dist/index.d.ts',
-      ]
+      const distFiles = ['./dist/index.js', './dist/index.d.ts']
 
       for (const f of distFiles) {
         expect(await existsFile(join(dir, f))).toBe(true)
@@ -312,6 +308,64 @@ const testCases: {
       )
     },
   },
+  {
+    name: 'bin/single-path',
+    args: [],
+    async expected(dir) {
+      const distFiles = [
+        join(dir, './dist/bin.js'),
+        join(dir, './dist/bin.d.ts'),
+      ]
+      for (const f of distFiles) {
+        expect(await existsFile(f)).toBe(true)
+      }
+      expect(await fs.readFile(distFiles[0], 'utf-8')).toContain(
+        '#!/usr/bin/env node',
+      )
+    },
+  },
+  {
+    name: 'bin/multi-path',
+    args: [],
+    async expected(dir) {
+      const distBinFiles = [
+        join(dir, './dist/bin/a.js'),
+        join(dir, './dist/bin/b.js'),
+      ]
+      const distTypeFiles = [
+        join(dir, './dist/bin/a.d.ts'),
+        join(dir, './dist/bin/b.d.ts'),
+      ]
+      const distFiles = distBinFiles.concat(distTypeFiles)
+
+      for (const distFile of distFiles) {
+        expect(await existsFile(distFile)).toBe(true)
+      }
+      for (const distScriptFile of distBinFiles) {
+        expect(await fs.readFile(distScriptFile, 'utf-8')).toContain(
+          '#!/usr/bin/env node',
+        )
+      }
+    },
+  },
+  {
+    name: 'bin/cts',
+    args: [],
+    async expected(dir) {
+      const distFiles = [
+        join(dir, './dist/bin/index.cjs'),
+        join(dir, './dist/bin/index.d.cts'),
+      ]
+
+      for (const distFile of distFiles) {
+        expect(await existsFile(distFile)).toBe(true)
+      }
+
+      expect(await fs.readFile(distFiles[0], 'utf-8')).toContain(
+        '#!/usr/bin/env node',
+      )
+    }
+  },
   {
     name: 'esm-shims',
     args: [],

test/integration/bin/cts/package.json

@@ -0,0 +1,3 @@
+{
+  "bin": "./dist/bin/index.cjs"
+}

test/integration/bin/cts/src/bin/index.cts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+const path = require('path')
+console.log(path.basename(__filename))

test/integration/bin/cts/tsconfig.json

@@ -0,0 +1 @@
+{}

test/integration/bin/multi-path/package.json

@@ -0,0 +1,6 @@
+{
+  "bin": {
+    "a": "./dist/bin/a.js",
+    "b": "./dist/bin/b.js"
+  }
+}

test/integration/bin/multi-path/src/bin/a.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+console.log('a')

test/integration/bin/multi-path/src/bin/b.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+console.log('b')

test/integration/bin/multi-path/tsconfig.json

@@ -0,0 +1 @@
+{}

test/integration/bin/single-path/package.json

@@ -0,0 +1,3 @@
+{
+  "bin": "./dist/bin.js"
+}

test/integration/bin/single-path/src/bin/index.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+console.log('Hello, world!')

test/integration/bin/single-path/tsconfig.json

@@ -0,0 +1 @@
+{}