@culur/config-tsdown 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @culur/config-tsdown
+
+## 1.1.0
+
+### Minor Changes
+
+- 🎉 Add `@culur/config-tsdown` package as a replacement for `@culur/config-tsup` ([`c828933`](https://github.com/culur/culur/commit/c828933f1c39505be8b2b1c5cbca6f0549bfa02d)) ([@phamhongphuc](https://github.com/phamhongphuc)).
+
+  This new package provides a standardized configuration for `tsdown`, supporting ESM and CJS formats with built-in TypeScript definitions and source mapping.
+
+- ⚙️ Migrate build system from `tsup` to `tsdown` across all packages ([`83b3791`](https://github.com/culur/culur/commit/83b379149b9e9536f4cd161976762afb35b6b61a)) ([@phamhongphuc](https://github.com/phamhongphuc)).
+
+### Patch Changes
+
+- ⚙️ Added `tsdown` to `devDependencies` for development and testing ([`1521d34`](https://github.com/culur/culur/commit/1521d34b3a6ac832a6f85d7ae8d3cc41f8622109)) ([@phamhongphuc](https://github.com/phamhongphuc)).
+
+- 🔨 Update internal references and configurations to align with the renaming of `defineObject` to `defineObjectFactory` ([`93080d5`](https://github.com/culur/culur/commit/93080d5424969774178f2035a3fc623b199ca64d)) ([@phamhongphuc](https://github.com/phamhongphuc)).

package/README.md

@@ -0,0 +1,133 @@
+# `@culur/config-tsdown`
+
+[![NPM Version](https://img.shields.io/npm/v/@culur/config-tsdown?logo=npm)](https://www.npmjs.com/package/@culur/config-tsdown)
+[![NPM Download](https://img.shields.io/npm/dm/@culur/config-tsdown?logo=npm)](https://www.npmjs.com/package/@culur/config-tsdown)
+[![NPM License](https://img.shields.io/npm/l/@culur/config-tsdown)](../../LICENSE)
+
+[![CodeFactor](https://www.codefactor.io/repository/github/culur/culur/badge)](https://www.codefactor.io/repository/github/culur/culur)
+[![Codecov](https://img.shields.io/codecov/c/github/culur/culur)](https://app.codecov.io/gh/culur/culur)
+[![Build and release](https://github.com/culur/culur/actions/workflows/build-and-release.yml/badge.svg)](https://github.com/culur/culur/actions/workflows/build-and-release.yml)
+
+> Sharing [tsdown](https://tsdown.dev/) configurations.
+
+## ✨ Features
+
+The library includes several tsdown configurations for reuse.
+
+### 1. Shared configuration
+
+```js
+const sharedConfig = {
+  sourcemap: true,
+  clean: true,
+  dts: true,
+  entry: [
+    'src/**/*.ts', //
+    '!src/**/*.test.ts',
+    '!src/**/*.spec.ts',
+  ],
+  treeshake: true,
+};
+```
+
+### 2. There are 3 complete configurations
+
+| Name      | Format       |
+| --------- | ------------ |
+| `esm`     | `esm`        |
+| `cjs`     | `cjs`        |
+| `esm_cjs` | `esm`, `cjs` |
+
+## 💿 Installation
+
+Add `@culur/config-tsdown` dependency to your project.
+
+```bash
+# Using npm
+npm install @culur/config-tsdown --save-dev
+
+# Using pnpm
+pnpm install @culur/config-tsdown --dev
+
+# Using yarn
+yarn add @culur/config-tsdown --dev
+```
+
+Other packages:
+
+- You also need to install `tsdown` and `typescript` packages in `devDependencies`.
+
+## 📖 Usage
+
+### 1. Use the config directly
+
+In `tsdown.config.ts`, use:
+
+```ts
+import { cjs, esm, esm_cjs } from '@culur/config-tsdown';
+
+// format 'esm'
+export default esm;
+
+// format 'cjs'
+export default cjs;
+
+// format 'esm_cjs'
+export default esm_cjs;
+```
+
+### 2. Overwrite some properties from the shared configuration
+
+In `tsdown.config.ts`, use `defineConfig`:
+
+```ts
+import { defineConfig, esm } from '@culur/config-tsdown';
+
+export default defineConfig({
+  ...esm,
+  //...
+});
+```
+
+## 🔄 Migrate from tsup
+
+If you are migrating from `@culur/config-tsup`, you can follow these steps:
+
+1. Replace `@culur/config-tsup` with `@culur/config-tsdown`.
+2. Update your `tsup.config.ts` to `tsdown.config.ts`.
+3. Change imports from `@culur/config-tsup` to `@culur/config-tsdown`.
+
+For more details on migrating from tsup to tsdown, please refer to the official [tsdown migration guide](https://tsdown.dev/guide/migrate-from-tsup).
+
+## 📜 Scripts
+
+Some commonly used scripts in `package.json`.
+
+```json
+{
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.cjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": ["CHANGELOG.md", "LICENSE", "README.md", "dist", "src"],
+  "scripts": {
+    "build": "tsdown"
+  }
+}
+```
+
+## 🗃️ Changelog
+
+See [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## 🔒 License
+
+See [LICENSE](../../LICENSE) for license rights and limitations (MIT).

package/dist/index.cjs

@@ -0,0 +1,33 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_types = require("./types-BrvIhA3f.cjs");
+//#region src/index.ts
+const sharedConfig = require_types.defineConfigPure({
+	sourcemap: true,
+	clean: true,
+	dts: true,
+	entry: [
+		"src/**/*.ts",
+		"!src/**/*.test.ts",
+		"!src/**/*.spec.ts"
+	],
+	treeshake: true
+});
+const esm = require_types.defineConfigPure({
+	...sharedConfig,
+	format: "esm"
+});
+const cjs = require_types.defineConfigPure({
+	...sharedConfig,
+	format: "cjs"
+});
+const esm_cjs = require_types.defineConfigPure({
+	...sharedConfig,
+	format: ["esm", "cjs"]
+});
+//#endregion
+exports.cjs = cjs;
+exports.defineConfig = require_types.defineConfig;
+exports.esm = esm;
+exports.esm_cjs = esm_cjs;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["defineConfigPure"],"sources":["../src/index.ts"],"sourcesContent":["import { defineConfigPure } from './types';\n\nexport { defineConfig } from './types';\n\nconst sharedConfig = defineConfigPure({\n  sourcemap: true,\n  clean: true,\n  dts: true,\n  entry: [\n    'src/**/*.ts', //\n    '!src/**/*.test.ts',\n    '!src/**/*.spec.ts',\n  ] as const,\n  treeshake: true,\n});\n\nexport const esm = defineConfigPure({\n  ...sharedConfig,\n  format: 'esm',\n});\n\nexport const cjs = defineConfigPure({\n  ...sharedConfig,\n  format: 'cjs',\n});\n\nexport const esm_cjs = defineConfigPure({\n  ...sharedConfig,\n  format: ['esm', 'cjs'] as const,\n});\n"],"mappings":";;;AAIA,MAAM,eAAeA,cAAAA,iBAAiB;CACpC,WAAW;CACX,OAAO;CACP,KAAK;CACL,OAAO;EACL;EACA;EACA;EACD;CACD,WAAW;CACZ,CAAC;AAEF,MAAa,MAAMA,cAAAA,iBAAiB;CAClC,GAAG;CACH,QAAQ;CACT,CAAC;AAEF,MAAa,MAAMA,cAAAA,iBAAiB;CAClC,GAAG;CACH,QAAQ;CACT,CAAC;AAEF,MAAa,UAAUA,cAAAA,iBAAiB;CACtC,GAAG;CACH,QAAQ,CAAC,OAAO,MAAM;CACvB,CAAC"}

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import { defineConfig } from "./types/index.cjs";
+
+//#region src/index.d.ts
+declare const esm: {
+  format: "esm";
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+declare const cjs: {
+  format: "cjs";
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+declare const esm_cjs: {
+  format: ["esm", "cjs"];
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+//#endregion
+export { cjs, defineConfig, esm, esm_cjs };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,30 @@
+import { defineConfig } from "./types/index.mjs";
+
+//#region src/index.d.ts
+declare const esm: {
+  format: "esm";
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+declare const cjs: {
+  format: "cjs";
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+declare const esm_cjs: {
+  format: ["esm", "cjs"];
+  sourcemap: true;
+  clean: true;
+  dts: true;
+  entry: ["src/**/*.ts", "!src/**/*.test.ts", "!src/**/*.spec.ts"];
+  treeshake: true;
+};
+//#endregion
+export { cjs, defineConfig, esm, esm_cjs };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,29 @@
+import { n as defineConfigPure, t as defineConfig } from "./types-78D1wC2M.mjs";
+//#region src/index.ts
+const sharedConfig = defineConfigPure({
+	sourcemap: true,
+	clean: true,
+	dts: true,
+	entry: [
+		"src/**/*.ts",
+		"!src/**/*.test.ts",
+		"!src/**/*.spec.ts"
+	],
+	treeshake: true
+});
+const esm = defineConfigPure({
+	...sharedConfig,
+	format: "esm"
+});
+const cjs = defineConfigPure({
+	...sharedConfig,
+	format: "cjs"
+});
+const esm_cjs = defineConfigPure({
+	...sharedConfig,
+	format: ["esm", "cjs"]
+});
+//#endregion
+export { cjs, defineConfig, esm, esm_cjs };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { defineConfigPure } from './types';\n\nexport { defineConfig } from './types';\n\nconst sharedConfig = defineConfigPure({\n  sourcemap: true,\n  clean: true,\n  dts: true,\n  entry: [\n    'src/**/*.ts', //\n    '!src/**/*.test.ts',\n    '!src/**/*.spec.ts',\n  ] as const,\n  treeshake: true,\n});\n\nexport const esm = defineConfigPure({\n  ...sharedConfig,\n  format: 'esm',\n});\n\nexport const cjs = defineConfigPure({\n  ...sharedConfig,\n  format: 'cjs',\n});\n\nexport const esm_cjs = defineConfigPure({\n  ...sharedConfig,\n  format: ['esm', 'cjs'] as const,\n});\n"],"mappings":";;AAIA,MAAM,eAAe,iBAAiB;CACpC,WAAW;CACX,OAAO;CACP,KAAK;CACL,OAAO;EACL;EACA;EACA;EACD;CACD,WAAW;CACZ,CAAC;AAEF,MAAa,MAAM,iBAAiB;CAClC,GAAG;CACH,QAAQ;CACT,CAAC;AAEF,MAAa,MAAM,iBAAiB;CAClC,GAAG;CACH,QAAQ;CACT,CAAC;AAEF,MAAa,UAAU,iBAAiB;CACtC,GAAG;CACH,QAAQ,CAAC,OAAO,MAAM;CACvB,CAAC"}

package/dist/types/index.cjs

@@ -0,0 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_types = require("../types-BrvIhA3f.cjs");
+exports.defineConfig = require_types.defineConfig;
+exports.defineConfigPure = require_types.defineConfigPure;

package/dist/types/index.d.cts

@@ -0,0 +1,8 @@
+import { UserConfig } from "tsdown";
+
+//#region src/types/index.d.ts
+declare const defineConfigPure: <TActualObject extends UserConfig>(object: TActualObject) => TActualObject;
+declare const defineConfig: <TActualObject extends UserConfig>(object: UserConfig | TActualObject) => UserConfig | TActualObject;
+//#endregion
+export { defineConfig, defineConfigPure };
+//# sourceMappingURL=index.d.cts.map

package/dist/types/index.d.mts

@@ -0,0 +1,8 @@
+import { UserConfig } from "tsdown";
+
+//#region src/types/index.d.ts
+declare const defineConfigPure: <TActualObject extends UserConfig>(object: TActualObject) => TActualObject;
+declare const defineConfig: <TActualObject extends UserConfig>(object: UserConfig | TActualObject) => UserConfig | TActualObject;
+//#endregion
+export { defineConfig, defineConfigPure };
+//# sourceMappingURL=index.d.mts.map

package/dist/types/index.mjs

@@ -0,0 +1,2 @@
+import { n as defineConfigPure, t as defineConfig } from "../types-78D1wC2M.mjs";
+export { defineConfig, defineConfigPure };

package/dist/types-78D1wC2M.mjs

@@ -0,0 +1,10 @@
+//#region ../types/src/define-object-factory.ts
+const defineObjectFactory = () => (object) => object;
+//#endregion
+//#region src/types/index.ts
+const defineConfigPure = defineObjectFactory();
+const defineConfig = defineObjectFactory();
+//#endregion
+export { defineConfigPure as n, defineConfig as t };
+
+//# sourceMappingURL=types-78D1wC2M.mjs.map

package/dist/types-78D1wC2M.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-78D1wC2M.mjs","names":[],"sources":["../../types/src/define-object-factory.ts","../src/types/index.ts"],"sourcesContent":["export const defineObjectFactory =\n  <TBaseObject, TAutoComplete extends boolean = false>() =>\n  <TActualObject extends TBaseObject>(\n    object: TAutoComplete extends true\n      ? TActualObject | TBaseObject\n      : TActualObject,\n  ) =>\n    object;\n","import type { UserConfig } from 'tsdown';\nimport { defineObjectFactory } from '../../../types/src/define-object-factory'; // external import\n\nexport const defineConfigPure = defineObjectFactory<UserConfig>();\n\nexport const defineConfig = defineObjectFactory<UserConfig, true>();\n"],"mappings":";AAAA,MAAa,6BAGT,WAIA;;;ACJJ,MAAa,mBAAmB,qBAAiC;AAEjE,MAAa,eAAe,qBAAuC"}

package/dist/types-BrvIhA3f.cjs

@@ -0,0 +1,21 @@
+//#region ../types/src/define-object-factory.ts
+const defineObjectFactory = () => (object) => object;
+//#endregion
+//#region src/types/index.ts
+const defineConfigPure = defineObjectFactory();
+const defineConfig = defineObjectFactory();
+//#endregion
+Object.defineProperty(exports, "defineConfig", {
+	enumerable: true,
+	get: function() {
+		return defineConfig;
+	}
+});
+Object.defineProperty(exports, "defineConfigPure", {
+	enumerable: true,
+	get: function() {
+		return defineConfigPure;
+	}
+});
+
+//# sourceMappingURL=types-BrvIhA3f.cjs.map

package/dist/types-BrvIhA3f.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BrvIhA3f.cjs","names":[],"sources":["../../types/src/define-object-factory.ts","../src/types/index.ts"],"sourcesContent":["export const defineObjectFactory =\n  <TBaseObject, TAutoComplete extends boolean = false>() =>\n  <TActualObject extends TBaseObject>(\n    object: TAutoComplete extends true\n      ? TActualObject | TBaseObject\n      : TActualObject,\n  ) =>\n    object;\n","import type { UserConfig } from 'tsdown';\nimport { defineObjectFactory } from '../../../types/src/define-object-factory'; // external import\n\nexport const defineConfigPure = defineObjectFactory<UserConfig>();\n\nexport const defineConfig = defineObjectFactory<UserConfig, true>();\n"],"mappings":";AAAA,MAAa,6BAGT,WAIA;;;ACJJ,MAAa,mBAAmB,qBAAiC;AAEjE,MAAa,eAAe,qBAAuC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@culur/config-tsdown",
+  "version": "1.1.0",
+  "description": "Culur's tsdown configuration",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/culur/culur.git",
+    "directory": "packages/config-tsdown"
+  },
+  "bugs": {
+    "url": "https://github.com/culur/culur/issues"
+  },
+  "homepage": "https://github.com/culur/culur/tree/main/packages/config-tsdown#readme",
+  "author": "culur <culur.net@gmail.com>",
+  "license": "MIT",
+  "keywords": [
+    "culur",
+    "config",
+    "typescript",
+    "tsdown"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "!**/*.test.*",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "clean": "rimraf dist coverage",
+    "build": "tsdown --config-loader unrun",
+    "test": "tsc --noEmit && vitest run"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "devDependencies": {
+    "@culur/config-typescript": "workspace:*",
+    "tsdown": "^0.21.6"
+  },
+  "peerDependencies": {
+    "tsdown": "^0.21.6"
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,9 @@
+import type { UserConfig } from 'tsdown';
+import { expectTypeOf, it } from 'vitest';
+import { cjs, esm, esm_cjs } from '.';
+
+it('config esm', () => {
+  expectTypeOf(esm).toExtend<UserConfig>();
+  expectTypeOf(cjs).toExtend<UserConfig>();
+  expectTypeOf(esm_cjs).toExtend<UserConfig>();
+});

package/src/index.ts

@@ -0,0 +1,30 @@
+import { defineConfigPure } from './types';
+
+export { defineConfig } from './types';
+
+const sharedConfig = defineConfigPure({
+  sourcemap: true,
+  clean: true,
+  dts: true,
+  entry: [
+    'src/**/*.ts', //
+    '!src/**/*.test.ts',
+    '!src/**/*.spec.ts',
+  ] as const,
+  treeshake: true,
+});
+
+export const esm = defineConfigPure({
+  ...sharedConfig,
+  format: 'esm',
+});
+
+export const cjs = defineConfigPure({
+  ...sharedConfig,
+  format: 'cjs',
+});
+
+export const esm_cjs = defineConfigPure({
+  ...sharedConfig,
+  format: ['esm', 'cjs'] as const,
+});

package/src/types/index.ts

@@ -0,0 +1,6 @@
+import type { UserConfig } from 'tsdown';
+import { defineObjectFactory } from '../../../types/src/define-object-factory'; // external import
+
+export const defineConfigPure = defineObjectFactory<UserConfig>();
+
+export const defineConfig = defineObjectFactory<UserConfig, true>();