feat: support ci-only / local-only on addon features

Author: sxzz

package.json

@@ -34,7 +34,7 @@
   "typesVersions": {
     "*": {
       "*": [
-        "./dist/*",
+        "./dist/*.d.mts",
         "./*"
       ]
     }
@@ -117,6 +117,7 @@
     "@vueuse/core": "catalog:docs",
     "bumpp": "catalog:dev",
     "eslint": "catalog:dev",
+    "is-in-ci": "catalog:prod",
     "lightningcss": "catalog:dev",
     "pkg-types": "catalog:dev",
     "prettier": "catalog:dev",

packages/create-tsdown/package.json

@@ -29,7 +29,7 @@
   "typesVersions": {
     "*": {
       "*": [
-        "./dist/*",
+        "./dist/*.d.mts",
         "./*"
       ]
     }

pnpm-lock.yaml

@@ -54,6 +54,7 @@ catalogs:
     empathic: ^2.0.0
     giget: ^2.0.0
     hookable: ^5.5.3
+    is-in-ci: ^2.0.0
     obug: ^2.1.1
     package-manager-detector: ^1.5.0
     rolldown: 1.0.0-beta.51

pnpm-workspace.yaml

@@ -3,6 +3,7 @@ import path from 'node:path'
 import process from 'node:process'
 import { pathToFileURL } from 'node:url'
 import { underline } from 'ansis'
+import isInCi from 'is-in-ci'
 import { createDebug } from 'obug'
 import { createConfigCoreLoader } from 'unconfig-core'
 import { fsStat } from '../utils/fs.ts'
@@ -119,7 +120,7 @@ export async function loadConfigFile(
 
     exported = await exported
     if (typeof exported === 'function') {
-      exported = await exported(inlineConfig)
+      exported = await exported(inlineConfig, { ci: isInCi })
     }
   }
 

src/config/config.ts

@@ -1,6 +1,7 @@
 import path from 'node:path'
 import process from 'node:process'
 import { blue } from 'ansis'
+import isInCi from 'is-in-ci'
 import { createDebug } from 'obug'
 import { glob } from 'tinyglobby'
 import { resolveClean } from '../features/clean.ts'
@@ -19,7 +20,12 @@ import { createLogger } from '../utils/logger.ts'
 import { normalizeFormat, readPackageJson } from '../utils/package.ts'
 import type { Awaitable } from '../utils/types.ts'
 import { loadConfigFile, loadViteConfig } from './config.ts'
-import type { InlineConfig, ResolvedConfig, UserConfig } from './types.ts'
+import type {
+  CIOption,
+  InlineConfig,
+  ResolvedConfig,
+  UserConfig,
+} from './types.ts'
 
 export * from './types.ts'
 
@@ -203,7 +209,7 @@ async function resolveUserConfig(
     env = {},
     copy,
     publicDir,
-    hash,
+    hash = true,
     cwd = process.cwd(),
     name,
     workspace,
@@ -221,7 +227,10 @@ async function resolveUserConfig(
     debug = false,
   } = userConfig
 
-  const logger = createLogger(logLevel, { customLogger, failOnWarn })
+  const logger = createLogger(logLevel, {
+    customLogger,
+    failOnWarn: resolveFeatureOption(failOnWarn, true),
+  })
 
   if (typeof bundle === 'boolean') {
     logger.warn('`bundle` option is deprecated. Use `unbundle` instead.')
@@ -260,9 +269,12 @@ async function resolveUserConfig(
     noExternal = resolveRegex(noExternal)
   }
 
-  if (publint === true) publint = {}
-  if (attw === true) attw = {}
-  if (exports === true) exports = {}
+  publint = resolveFeatureOption(publint, {})
+  attw = resolveFeatureOption(attw, {})
+  exports = resolveFeatureOption(exports, {})
+  unused = resolveFeatureOption(unused, {})
+  report = resolveFeatureOption(report, {})
+  dts = resolveFeatureOption(dts, {})
 
   if (publicDir) {
     if (copy) {
@@ -316,8 +328,8 @@ async function resolveUserConfig(
     inlineOnly = toArray(inlineOnly)
   }
 
+  debug = resolveFeatureOption(debug, {})
   if (debug) {
-    if (debug === true) debug = {}
     debug.devtools ??= !!pkgExists('@vitejs/devtools/cli')
   }
 
@@ -333,8 +345,8 @@ async function resolveUserConfig(
     treeshake,
     platform,
     sourcemap,
-    dts: dts === true ? {} : dts,
-    report: report === true ? {} : report,
+    dts,
+    report,
     unused,
     watch,
     ignoreWatch,
@@ -348,7 +360,7 @@ async function resolveUserConfig(
     env,
     pkg,
     copy: publicDir || copy,
-    hash: hash ?? true,
+    hash,
     name,
     external,
     noExternal,
@@ -378,3 +390,13 @@ export async function mergeUserOptions<T extends object, A extends unknown[]>(
     typeof user === 'function' ? await user(defaults, ...args) : user
   return { ...defaults, ...userOutputOptions }
 }
+
+function resolveFeatureOption<T>(
+  value: boolean | CIOption | T,
+  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
+  return value
+}

src/config/index.ts

@@ -93,6 +93,8 @@ export type NoExternalFn = (
   importer: string | undefined,
 ) => boolean | null | undefined | void
 
+export type CIOption = 'ci-only' | 'local-only'
+
 /**
  * Options for tsdown.
  */
@@ -243,7 +245,7 @@ export interface UserConfig {
 
   //#region Output Options
 
-  /** @default ['es'] */
+  /** @default 'es' */
   format?: Format | Format[]
   globalName?: string
   /** @default 'dist' */
@@ -353,7 +355,7 @@ export interface UserConfig {
    * If true, fails the build on warnings.
    * @default false
    */
-  failOnWarn?: boolean
+  failOnWarn?: boolean | CIOption
   /**
    * Custom logger.
    */
@@ -387,7 +389,7 @@ export interface UserConfig {
    *
    * @default false
    */
-  debug?: boolean | DebugOptions
+  debug?: boolean | CIOption | DebugOptions
 
   //#region Addons
 
@@ -398,21 +400,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 | DtsOptions
+  dts?: boolean | CIOption | DtsOptions
 
   /**
    * Enable unused dependencies check with `unplugin-unused`
    * Requires `unplugin-unused` to be installed.
    * @default false
    */
-  unused?: boolean | UnusedOptions
+  unused?: boolean | CIOption | UnusedOptions
 
   /**
    * Run publint after bundling.
    * Requires `publint` to be installed.
    * @default false
    */
-  publint?: boolean | PublintOptions
+  publint?: boolean | CIOption | PublintOptions
 
   /**
    * Run `arethetypeswrong` after bundling.
@@ -421,13 +423,13 @@ export interface UserConfig {
    * @default false
    * @see https://github.com/arethetypeswrong/arethetypeswrong.github.io
    */
-  attw?: boolean | AttwOptions
+  attw?: boolean | CIOption | AttwOptions
 
   /**
    * Enable size reporting after bundling.
    * @default true
    */
-  report?: boolean | ReportOptions
+  report?: boolean | CIOption | ReportOptions
 
   /**
    * `import.meta.glob` support.
@@ -442,7 +444,7 @@ export interface UserConfig {
    * This will set the `main`, `module`, `types`, `exports` fields in `package.json`
    * to point to the generated files.
    */
-  exports?: boolean | ExportsOptions
+  exports?: boolean | CIOption | ExportsOptions
 
   /**
    * @deprecated Alias for `copy`, will be removed in the future.
@@ -492,6 +494,7 @@ export interface InlineConfig extends UserConfig {
 
 export type UserConfigFn = (
   inlineConfig: InlineConfig,
+  context: { ci: boolean },
 ) => Awaitable<Arrayable<UserConfig>>
 
 export type UserConfigExport = Awaitable<Arrayable<UserConfig> | UserConfigFn>
@@ -530,16 +533,20 @@ export type ResolvedConfig = Overwrite<
     format: NormalizedFormat[]
     target?: string[]
     clean: string[]
-    dts: false | DtsOptions
-    report: false | ReportOptions
-    tsconfig: false | string
     pkg?: PackageJson
-    exports: false | ExportsOptions
     nodeProtocol: 'strip' | boolean
     logger: Logger
     ignoreWatch: Array<string | RegExp>
     noExternal?: NoExternalFn
     inlineOnly?: Array<string | RegExp>
+
+    dts: false | DtsOptions
+    report: false | ReportOptions
+    tsconfig: false | string
+    exports: false | ExportsOptions
     debug: false | DebugOptions
+    publint: false | PublintOptions
+    attw: false | AttwOptions
+    unused: false | UnusedOptions
   }
 >

src/config/types.ts

@@ -114,11 +114,7 @@ export async function attw(options: ResolvedConfig): Promise<void> {
     options.logger.warn('attw is enabled but package.json is not found')
     return
   }
-  const {
-    profile = 'strict',
-    level = 'warn',
-    ...attwOptions
-  } = options.attw === true ? {} : options.attw
+  const { profile = 'strict', level = 'warn', ...attwOptions } = options.attw
 
   const t = performance.now()
   debug('Running attw check')

src/features/attw.ts

@@ -23,7 +23,7 @@ export async function publint(options: ResolvedConfig): Promise<void> {
   const { publint } = await importWithError<typeof import('publint')>('publint')
   const { formatMessage } = await import('publint/utils')
   const { messages } = await publint({
-    ...(options.publint === true ? {} : options.publint),
+    ...options.publint,
     pkgDir: path.dirname(options.pkg.packageJsonPath),
   })
   debug('Found %d issues', messages.length)

src/features/publint.ts

@@ -136,7 +136,7 @@ async function resolveInputOptions(
       plugins.push(
         Unused.rolldown({
           root: cwd,
-          ...(unused === true ? {} : unused),
+          ...unused,
         }),
       )
     }