@jmlweb/tsup-config-base 1.0.0

package/README.md

@@ -0,0 +1,232 @@
+# @jmlweb/tsup-config-base
+
+[![npm version](https://img.shields.io/npm/v/@jmlweb/tsup-config-base)](https://www.npmjs.com/package/@jmlweb/tsup-config-base)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-339933.svg)](https://nodejs.org/)
+[![tsup](https://img.shields.io/badge/tsup-8.0%2B-yellow.svg)](https://tsup.egoist.dev/)
+
+> Base tsup configuration for jmlweb projects. Provides sensible defaults and a clean API for creating consistent build configurations.
+
+## Features
+
+- **Sensible Defaults**: Pre-configured with common settings for TypeScript libraries
+- **Dual Format**: Generates both CommonJS and ESM outputs by default
+- **TypeScript Declarations**: Automatic `.d.ts` generation enabled
+- **Clean API**: Simple function to create configurations with external dependencies
+- **Zero Config**: Works out of the box with minimal setup
+- **Fully Typed**: Complete TypeScript support with exported types
+
+## Installation
+
+```bash
+npm install --save-dev @jmlweb/tsup-config-base tsup
+```
+
+## Quick Start
+
+Create a `tsup.config.ts` file in your project root:
+
+```typescript
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig();
+```
+
+## Examples
+
+### Basic Setup (No Externals)
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig();
+```
+
+### With External Dependencies
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig({
+  external: ['eslint', 'typescript-eslint', '@eslint/js'],
+});
+```
+
+### With Internal Workspace Dependencies
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig({
+  external: [
+    // Internal packages
+    '@jmlweb/eslint-config-base-js',
+    // External peer dependencies
+    '@eslint/js',
+    'eslint',
+    'eslint-config-prettier',
+    'typescript-eslint',
+  ],
+});
+```
+
+### Custom Entry Point
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig({
+  entry: ['src/main.ts'],
+  external: ['some-dependency'],
+});
+```
+
+### With Additional Options
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig({
+  external: ['vitest'],
+  options: {
+    minify: true,
+    sourcemap: true,
+    splitting: true,
+  },
+});
+```
+
+### Multiple Entry Points
+
+```typescript
+// tsup.config.ts
+import { createTsupConfig } from '@jmlweb/tsup-config-base';
+
+export default createTsupConfig({
+  entry: ['src/index.ts', 'src/cli.ts'],
+  external: ['commander'],
+});
+```
+
+## Configuration Details
+
+### Default Settings
+
+| Setting    | Default Value      | Description                         |
+| ---------- | ------------------ | ----------------------------------- |
+| `entry`    | `['src/index.ts']` | Entry point(s) for the build        |
+| `format`   | `['cjs', 'esm']`   | Output formats (dual publishing)    |
+| `dts`      | `true`             | Generate TypeScript declarations    |
+| `clean`    | `true`             | Clean output directory before build |
+| `outDir`   | `'dist'`           | Output directory                    |
+| `external` | `[]`               | External packages to exclude        |
+
+### API Reference
+
+#### `createTsupConfig(options?: TsupConfigOptions): Options`
+
+Creates a tsup configuration with sensible defaults.
+
+**Parameters:**
+
+| Option     | Type                           | Default            | Description                      |
+| ---------- | ------------------------------ | ------------------ | -------------------------------- |
+| `entry`    | `string[]`                     | `['src/index.ts']` | Entry point files                |
+| `format`   | `('cjs' \| 'esm' \| 'iife')[]` | `['cjs', 'esm']`   | Output formats                   |
+| `dts`      | `boolean`                      | `true`             | Generate declaration files       |
+| `clean`    | `boolean`                      | `true`             | Clean output before build        |
+| `outDir`   | `string`                       | `'dist'`           | Output directory                 |
+| `external` | `(string \| RegExp)[]`         | `[]`               | Packages to exclude from bundle  |
+| `options`  | `Partial<Options>`             | `{}`               | Additional tsup options to merge |
+
+**Returns:** A complete tsup `Options` object.
+
+#### `BASE_DEFAULTS`
+
+Exported constant containing the default configuration values for reference.
+
+#### `Options` (re-exported from tsup)
+
+The tsup Options type is re-exported for convenience when extending configurations.
+
+## When to Use
+
+Use this configuration when you want:
+
+- Consistent build configuration across multiple packages
+- Dual-format output (CommonJS + ESM) for maximum compatibility
+- Automatic TypeScript declaration generation
+- A clean, simple API for specifying externals
+- Easy customization without repeating boilerplate
+
+## Externals Strategy
+
+When configuring `external`, include:
+
+1. **Peer dependencies**: Packages that consumers should install themselves
+2. **Workspace dependencies**: Internal `@jmlweb/*` packages used via `workspace:*`
+3. **Optional dependencies**: Packages that may or may not be present
+
+```typescript
+// Example: ESLint config package
+export default createTsupConfig({
+  external: [
+    // Internal workspace dependency
+    '@jmlweb/eslint-config-base-js',
+    // Peer dependencies
+    '@eslint/js',
+    'eslint',
+    'eslint-config-prettier',
+    'eslint-plugin-simple-import-sort',
+    'typescript-eslint',
+  ],
+});
+```
+
+## Usage with Scripts
+
+Add build scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm build"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run build    # Build the package
+npm run clean    # Clean build output
+```
+
+## Requirements
+
+- **Node.js** >= 18.0.0
+- **tsup** >= 8.0.0
+
+## Peer Dependencies
+
+This package requires the following peer dependency:
+
+- `tsup` (>=8.0.0)
+
+## Related Packages
+
+- [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint config for TypeScript projects
+- [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier config for consistent formatting
+- [`@jmlweb/tsconfig-base`](../tsconfig-base) - TypeScript configuration
+- [`@jmlweb/vitest-config`](../vitest-config) - Vitest configuration for testing
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,58 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BASE_DEFAULTS: () => BASE_DEFAULTS,
+  createTsupConfig: () => createTsupConfig
+});
+module.exports = __toCommonJS(index_exports);
+var BASE_DEFAULTS = {
+  entry: ["src/index.ts"],
+  format: ["cjs", "esm"],
+  dts: true,
+  clean: true,
+  outDir: "dist"
+};
+var createTsupConfig = (config = {}) => {
+  const {
+    entry = BASE_DEFAULTS.entry,
+    format = BASE_DEFAULTS.format,
+    dts = BASE_DEFAULTS.dts,
+    clean = BASE_DEFAULTS.clean,
+    outDir = BASE_DEFAULTS.outDir,
+    external = [],
+    options = {}
+  } = config;
+  return {
+    entry,
+    format,
+    dts,
+    clean,
+    outDir,
+    ...external.length > 0 && { external },
+    ...options
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BASE_DEFAULTS,
+  createTsupConfig
+});

package/dist/index.d.cts

@@ -0,0 +1,88 @@
+import { Options } from 'tsup';
+export { Options } from 'tsup';
+
+/**
+ * Options for creating a base tsup configuration
+ */
+interface TsupConfigOptions {
+    /**
+     * Entry points for the build
+     * @default ['src/index.ts']
+     */
+    entry?: string[];
+    /**
+     * Output formats
+     * @default ['cjs', 'esm']
+     */
+    format?: ('cjs' | 'esm' | 'iife')[];
+    /**
+     * Generate TypeScript declaration files
+     * @default true
+     */
+    dts?: boolean;
+    /**
+     * Clean output directory before build
+     * @default true
+     */
+    clean?: boolean;
+    /**
+     * Output directory
+     * @default 'dist'
+     */
+    outDir?: string;
+    /**
+     * External packages to exclude from the bundle
+     * Typically includes peer dependencies and internal workspace packages
+     * @default []
+     */
+    external?: (string | RegExp)[];
+    /**
+     * Additional tsup options to merge with the base configuration
+     */
+    options?: Omit<Options, 'entry' | 'format' | 'dts' | 'clean' | 'outDir' | 'external'>;
+}
+/**
+ * Base tsup configuration defaults used across all @jmlweb packages
+ */
+declare const BASE_DEFAULTS: {
+    entry: string[];
+    format: ("cjs" | "esm")[];
+    dts: true;
+    clean: true;
+    outDir: string;
+};
+/**
+ * Creates a base tsup configuration with sensible defaults
+ *
+ * @example
+ * ```typescript
+ * // Simple usage without externals
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With external dependencies
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig({
+ *   external: ['eslint', 'typescript-eslint', '@eslint/js'],
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With additional options
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig({
+ *   external: ['vitest'],
+ *   options: {
+ *     minify: true,
+ *     sourcemap: true,
+ *   },
+ * });
+ * ```
+ */
+declare const createTsupConfig: (config?: TsupConfigOptions) => Options;
+
+export { BASE_DEFAULTS, type TsupConfigOptions, createTsupConfig };

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { Options } from 'tsup';
+export { Options } from 'tsup';
+
+/**
+ * Options for creating a base tsup configuration
+ */
+interface TsupConfigOptions {
+    /**
+     * Entry points for the build
+     * @default ['src/index.ts']
+     */
+    entry?: string[];
+    /**
+     * Output formats
+     * @default ['cjs', 'esm']
+     */
+    format?: ('cjs' | 'esm' | 'iife')[];
+    /**
+     * Generate TypeScript declaration files
+     * @default true
+     */
+    dts?: boolean;
+    /**
+     * Clean output directory before build
+     * @default true
+     */
+    clean?: boolean;
+    /**
+     * Output directory
+     * @default 'dist'
+     */
+    outDir?: string;
+    /**
+     * External packages to exclude from the bundle
+     * Typically includes peer dependencies and internal workspace packages
+     * @default []
+     */
+    external?: (string | RegExp)[];
+    /**
+     * Additional tsup options to merge with the base configuration
+     */
+    options?: Omit<Options, 'entry' | 'format' | 'dts' | 'clean' | 'outDir' | 'external'>;
+}
+/**
+ * Base tsup configuration defaults used across all @jmlweb packages
+ */
+declare const BASE_DEFAULTS: {
+    entry: string[];
+    format: ("cjs" | "esm")[];
+    dts: true;
+    clean: true;
+    outDir: string;
+};
+/**
+ * Creates a base tsup configuration with sensible defaults
+ *
+ * @example
+ * ```typescript
+ * // Simple usage without externals
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With external dependencies
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig({
+ *   external: ['eslint', 'typescript-eslint', '@eslint/js'],
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With additional options
+ * import { createTsupConfig } from '@jmlweb/tsup-config-base';
+ * export default createTsupConfig({
+ *   external: ['vitest'],
+ *   options: {
+ *     minify: true,
+ *     sourcemap: true,
+ *   },
+ * });
+ * ```
+ */
+declare const createTsupConfig: (config?: TsupConfigOptions) => Options;
+
+export { BASE_DEFAULTS, type TsupConfigOptions, createTsupConfig };

package/dist/index.js

@@ -0,0 +1,32 @@
+// src/index.ts
+var BASE_DEFAULTS = {
+  entry: ["src/index.ts"],
+  format: ["cjs", "esm"],
+  dts: true,
+  clean: true,
+  outDir: "dist"
+};
+var createTsupConfig = (config = {}) => {
+  const {
+    entry = BASE_DEFAULTS.entry,
+    format = BASE_DEFAULTS.format,
+    dts = BASE_DEFAULTS.dts,
+    clean = BASE_DEFAULTS.clean,
+    outDir = BASE_DEFAULTS.outDir,
+    external = [],
+    options = {}
+  } = config;
+  return {
+    entry,
+    format,
+    dts,
+    clean,
+    outDir,
+    ...external.length > 0 && { external },
+    ...options
+  };
+};
+export {
+  BASE_DEFAULTS,
+  createTsupConfig
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@jmlweb/tsup-config-base",
+  "version": "1.0.0",
+  "description": "Base tsup configuration for jmlweb projects with sensible defaults",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "build",
+    "bundler",
+    "config",
+    "tsup",
+    "tsup-config",
+    "typescript"
+  ],
+  "author": "jmlweb",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmlweb/tooling.git"
+  },
+  "bugs": "https://github.com/jmlweb/tooling/issues",
+  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/tsup-config-base#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "tsup": ">=8.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "@jmlweb/tsconfig-internal": "0.0.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist"
+  }
+}