feat: add enabled option to feature options

Author: sxzz

src/config/index.test.ts

@@ -0,0 +1,57 @@
+import isInCi from 'is-in-ci'
+import { describe, expect, test } from 'vitest'
+import { resolveFeatureOption as _resolveFeatureOption } from './index.ts'
+
+const defaultOption = { a: 1 }
+interface DefaultOption {
+  a?: number
+}
+const resolveFeatureOption = _resolveFeatureOption<DefaultOption>
+
+describe('resolveFeatureOption', () => {
+  test('literal boolean', () => {
+    expect(resolveFeatureOption(true, defaultOption)).toBe(defaultOption)
+    expect(resolveFeatureOption(false, defaultOption)).toBe(false)
+  })
+
+  test('literal CI', () => {
+    expect(resolveFeatureOption('ci-only', defaultOption)).toBe(
+      isInCi ? defaultOption : false,
+    )
+    expect(resolveFeatureOption('local-only', defaultOption)).toBe(
+      isInCi ? false : defaultOption,
+    )
+  })
+
+  test('object with boolean enabled', () => {
+    {
+      const value = { a: 42 }
+      expect(resolveFeatureOption(value, defaultOption)).toBe(value)
+    }
+
+    {
+      const value = { enabled: true, a: 42 }
+      expect(resolveFeatureOption(value, defaultOption)).toBe(value)
+    }
+
+    expect(resolveFeatureOption({ enabled: false, a: 42 }, defaultOption)).toBe(
+      false,
+    )
+  })
+
+  test('object with CI enabled', () => {
+    {
+      const value = { enabled: 'ci-only' as const, a: 42 }
+      expect(resolveFeatureOption(value, defaultOption)).toBe(
+        isInCi ? value : false,
+      )
+    }
+
+    {
+      const value = { enabled: 'local-only' as const, a: 42 }
+      expect(resolveFeatureOption(value, defaultOption)).toBe(
+        isInCi ? false : value,
+      )
+    }
+  })
+})

src/config/index.ts

@@ -25,6 +25,7 @@ import type {
   InlineConfig,
   ResolvedConfig,
   UserConfig,
+  WithEnabled,
 } from './types.ts'
 
 export * from './types.ts'
@@ -391,12 +392,18 @@ export async function mergeUserOptions<T extends object, A extends unknown[]>(
   return { ...defaults, ...userOutputOptions }
 }
 
-function resolveFeatureOption<T>(
-  value: boolean | CIOption | T,
+export function resolveFeatureOption<T>(
+  value: Exclude<WithEnabled<T>, undefined>,
   defaults: T,
 ): T | false {
-  if (value === true) return defaults
-  if (value === 'ci-only') return isInCi ? defaults : false
-  if (value === 'local-only') return isInCi ? false : defaults
+  if (typeof value === 'object' && value !== null) {
+    return resolveCIOption(value.enabled ?? true) ? value : false
+  }
+  return resolveCIOption(value) ? defaults : false
+}
+
+function resolveCIOption(value: boolean | CIOption): boolean {
+  if (value === 'ci-only') return isInCi ? true : false
+  if (value === 'local-only') return isInCi ? false : true
   return value
 }

src/config/types.ts

@@ -95,6 +95,15 @@ export type NoExternalFn = (
 
 export type CIOption = 'ci-only' | 'local-only'
 
+export type WithEnabled<T> =
+  | boolean
+  | undefined
+  | CIOption
+  | (T & {
+      /** @default true */
+      enabled?: boolean | CIOption
+    })
+
 /**
  * Options for tsdown.
  */
@@ -389,7 +398,7 @@ export interface UserConfig {
    *
    * @default false
    */
-  debug?: boolean | CIOption | DebugOptions
+  debug?: WithEnabled<DebugOptions>
 
   //#region Addons
 
@@ -400,21 +409,21 @@ export interface UserConfig {
    * - If the `types` field is present, or if the main `exports` contains a `types` entry, declaration file generation is enabled by default.
    * - Otherwise, declaration file generation is disabled by default.
    */
-  dts?: boolean | CIOption | DtsOptions
+  dts?: WithEnabled<DtsOptions>
 
   /**
    * Enable unused dependencies check with `unplugin-unused`
    * Requires `unplugin-unused` to be installed.
    * @default false
    */
-  unused?: boolean | CIOption | UnusedOptions
+  unused?: WithEnabled<UnusedOptions>
 
   /**
    * Run publint after bundling.
    * Requires `publint` to be installed.
    * @default false
    */
-  publint?: boolean | CIOption | PublintOptions
+  publint?: WithEnabled<PublintOptions>
 
   /**
    * Run `arethetypeswrong` after bundling.
@@ -423,13 +432,13 @@ export interface UserConfig {
    * @default false
    * @see https://github.com/arethetypeswrong/arethetypeswrong.github.io
    */
-  attw?: boolean | CIOption | AttwOptions
+  attw?: WithEnabled<AttwOptions>
 
   /**
    * Enable size reporting after bundling.
    * @default true
    */
-  report?: boolean | CIOption | ReportOptions
+  report?: WithEnabled<ReportOptions>
 
   /**
    * `import.meta.glob` support.
@@ -444,7 +453,7 @@ export interface UserConfig {
    * This will set the `main`, `module`, `types`, `exports` fields in `package.json`
    * to point to the generated files.
    */
-  exports?: boolean | CIOption | ExportsOptions
+  exports?: WithEnabled<ExportsOptions>
 
   /**
    * @deprecated Alias for `copy`, will be removed in the future.

tsdown.config.ts

@@ -15,6 +15,10 @@ export default defineConfig([
       ],
     },
     publint: 'ci-only',
+    attw: {
+      enabled: 'ci-only',
+      profile: 'esmOnly',
+    },
     exports: {
       customExports(exports) {
         exports['./client'] = './client.d.ts'
@@ -33,6 +37,10 @@ export default defineConfig([
     inlineOnly: [],
     failOnWarn: 'ci-only',
     publint: 'ci-only',
+    attw: {
+      enabled: 'ci-only',
+      profile: 'esmOnly',
+    },
     exports: true,
   },
 ])