@workleap/tsup-configs 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @workleap/tsup-configs
 
+## 2.0.0
+
+### Major Changes
+
+- [#85](https://github.com/workleap/wl-web-configs/pull/85) [`bad2df7`](https://github.com/workleap/wl-web-configs/commit/bad2df75593fb70d431d73bdced653b157c50caa) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Updated TSUP configuration and added a new SWC config package
+
+## 1.0.1
+
+### Patch Changes
+
+- [#74](https://github.com/workleap/wl-web-configs/pull/74) [`43c9eb1`](https://github.com/workleap/wl-web-configs/commit/43c9eb11e61896855666c44beb0e711c82a560a3) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Updated installation documentation
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -1,4 +1,5 @@
-# `@workleap/tsup-configs`
+# @workleap/tsup-configs
+
 Workleap's recommended [tsup](https://tsup.egoist.dev/) configs.
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE)
@@ -6,11 +7,24 @@ Workleap's recommended [tsup](https://tsup.egoist.dev/) configs.
 
 ## Installation
 
-Install the package.
+Install the following packages:
 
 **With pnpm**
+
+```shell
+pnpm add -D @workleap/tsup-configs tsup
+```
+
+**With yarn**
+
 ```shell
-pnpm add -D @workleap/tsup-configs
+yarn add -D @workleap/tsup-configs tsup
+```
+
+**With npm**
+
+```shell
+npm install -D @workleap/tsup-configs tsup
 ```
 
 ## Usage
@@ -23,20 +37,64 @@ To build your React or TypeScript library project, follow these steps:
 
 ```ts
 // tsup.dev.ts
-import { defineDevConfig } from "tsup";
+import { defineDevConfig } from "@workleap/tsup-configs";
 
 export default defineDevConfig();
 ```
 
+You can override any existing options:
+
+```ts
+// tsup.dev.ts
+import { defineDevConfig } from "@workleap/tsup-configs";
+
+export default defineDevConfig({
+    clean: true
+});
+```
+
+The provided options will be merged with the default options. Given that a provided option match a default option, it will override the default option. If you prefer to extend the default option, you can import the `DefaultDevOptions` object and handle the merging code in your configuration file:
+
+```ts
+// tsup.dev.ts
+import { defineDevConfig, DefaultDevOptions } from "@workleap/tsup-configs";
+
+export default defineDevConfig({
+    format: ["cjs", ...DefaultDevOptions.format]
+});
+```
+
 3. Open the `tsup.build.ts` file and add the following code:
 
 ```ts
 // tsup.build.ts
-import { defineBuildConfig } from "tsup";
+import { defineBuildConfig } from "@workleap/tsup-configs";
 
 export default defineBuildConfig();
 ```
 
+You can override any existing options:
+
+```ts
+// tsup.build.ts
+import { defineBuildConfig } from "@workleap/tsup-configs";
+
+export default defineBuildConfig({
+    clean: true
+});
+```
+
+The provided options will be merged with the default options. Given that a provided option matches a default option, it will override the default option. If you prefer to extend the default option, you can import the `DefaultBuildOptions` object and handle the merging code in your configuration file:
+
+```ts
+// tsup.build.ts
+import { defineBuildConfig, DefaultBuildOptions } from "@workleap/tsup-configs";
+
+export default defineBuildConfig({
+    format: ["cjs", ...DefaultBuildOptions.format]
+});
+```
+
 4. In your package.json file, add the following scripts:
 
 ```json
@@ -47,11 +105,12 @@ export default defineBuildConfig();
 Now you can use the `dev` script to run tsup in watch mode and the `build` script to build your library.
 
 ## Customization
+
 If you want to use additional tsup options or override the default ones, you can pass a custom tsup config to the functions exported by this packages:
 
 ```ts
 // tsup.config.ts
-import { defineBuildConfig } from "tsup";
+import { defineBuildConfig } from "@workleap/tsup-configs";
 
 export default defineBuildConfig({
     entry: ["lib/index.ts"],
@@ -61,6 +120,14 @@ export default defineBuildConfig({
 
 [Check out all available options here](https://paka.dev/npm/tsup#module-index-export-Options) or the documentation website at https://tsup.egoist.dev/
 
+## Maintainers notes
+
+### CJS support
+
+To support CJS projects, the package is build for ESM and CJS formats. To support CJS, `type: "module"` has been temporary removed from the `package.json` file.
+
+Once all our projects use ESM, CJS support can be removed.
+
 ## License
 
 Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.

package/dist/build.d.ts

@@ -1,6 +1,16 @@
-import * as tsup from 'tsup';
-import { DefineConfigOptions } from './mergeConfigs.js';
+import { Options } from 'tsup';
+import { DefineConfigOptions } from './defineConfig.js';
 
-declare function defineBuildConfig(config?: DefineConfigOptions): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+declare const DefaultBuildOptions: {
+    clean: true;
+    dts: true;
+    treeshake: true;
+    entry: string[];
+    outDir: string;
+    format: string;
+    target: "esnext";
+    platform: "browser";
+};
+declare function defineBuildConfig(options?: DefineConfigOptions): Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
 
-export { defineBuildConfig };
+export { DefaultBuildOptions, defineBuildConfig };

package/dist/build.js

@@ -1,2 +1,48 @@
-export { a as defineBuildConfig } from './chunk-VN7SD7ZN.js';
-import './chunk-KJNVYY35.js';
+'use strict';
+
+var tsup = require('tsup');
+
+// src/defineConfig.ts
+function defineConfig(baseOptions, userOptions) {
+  if (!userOptions || Array.isArray(userOptions) && userOptions.length === 0) {
+    return tsup.defineConfig(baseOptions);
+  }
+  if (typeof userOptions === "function") {
+    return tsup.defineConfig((...args) => ({
+      ...baseOptions,
+      ...userOptions(...args)
+    }));
+  }
+  if (Array.isArray(userOptions)) {
+    return tsup.defineConfig(
+      userOptions.map((configItem) => {
+        return {
+          ...baseOptions,
+          ...configItem
+        };
+      })
+    );
+  }
+  return tsup.defineConfig({
+    ...baseOptions,
+    ...userOptions
+  });
+}
+
+// src/build.ts
+var DefaultBuildOptions = {
+  clean: true,
+  dts: true,
+  treeshake: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser"
+};
+function defineBuildConfig(options) {
+  return defineConfig(DefaultBuildOptions, options);
+}
+
+exports.DefaultBuildOptions = DefaultBuildOptions;
+exports.defineBuildConfig = defineBuildConfig;

package/dist/build.mjs

@@ -0,0 +1,2 @@
+export { DefaultBuildOptions, defineBuildConfig } from './chunk-AJHZ7CZ5.mjs';
+import './chunk-OUAGRIOH.mjs';

package/dist/chunk-AJHZ7CZ5.mjs

@@ -0,0 +1,18 @@
+import { defineConfig } from './chunk-OUAGRIOH.mjs';
+
+// src/build.ts
+var DefaultBuildOptions = {
+  clean: true,
+  dts: true,
+  treeshake: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser"
+};
+function defineBuildConfig(options) {
+  return defineConfig(DefaultBuildOptions, options);
+}
+
+export { DefaultBuildOptions, defineBuildConfig };

package/dist/chunk-OUAGRIOH.mjs

@@ -0,0 +1,30 @@
+import { defineConfig as defineConfig$1 } from 'tsup';
+
+// src/defineConfig.ts
+function defineConfig(baseOptions, userOptions) {
+  if (!userOptions || Array.isArray(userOptions) && userOptions.length === 0) {
+    return defineConfig$1(baseOptions);
+  }
+  if (typeof userOptions === "function") {
+    return defineConfig$1((...args) => ({
+      ...baseOptions,
+      ...userOptions(...args)
+    }));
+  }
+  if (Array.isArray(userOptions)) {
+    return defineConfig$1(
+      userOptions.map((configItem) => {
+        return {
+          ...baseOptions,
+          ...configItem
+        };
+      })
+    );
+  }
+  return defineConfig$1({
+    ...baseOptions,
+    ...userOptions
+  });
+}
+
+export { defineConfig };

package/dist/chunk-TG5YPRC3.mjs

@@ -0,0 +1,18 @@
+import { defineConfig } from './chunk-OUAGRIOH.mjs';
+
+// src/dev.ts
+var DefaultDevOptions = {
+  dts: true,
+  watch: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser",
+  sourcemap: "inline"
+};
+function defineDevConfig(options) {
+  return defineConfig(DefaultDevOptions, options);
+}
+
+export { DefaultDevOptions, defineDevConfig };

package/dist/defineConfig.d.ts

@@ -0,0 +1,6 @@
+import { defineConfig as defineConfig$1, Options } from 'tsup';
+
+type DefineConfigOptions = Parameters<typeof defineConfig$1>[0];
+declare function defineConfig(baseOptions: Options, userOptions?: DefineConfigOptions): ReturnType<typeof defineConfig$1>;
+
+export { DefineConfigOptions, defineConfig };

package/dist/defineConfig.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var tsup = require('tsup');
+
+// src/defineConfig.ts
+function defineConfig(baseOptions, userOptions) {
+  if (!userOptions || Array.isArray(userOptions) && userOptions.length === 0) {
+    return tsup.defineConfig(baseOptions);
+  }
+  if (typeof userOptions === "function") {
+    return tsup.defineConfig((...args) => ({
+      ...baseOptions,
+      ...userOptions(...args)
+    }));
+  }
+  if (Array.isArray(userOptions)) {
+    return tsup.defineConfig(
+      userOptions.map((configItem) => {
+        return {
+          ...baseOptions,
+          ...configItem
+        };
+      })
+    );
+  }
+  return tsup.defineConfig({
+    ...baseOptions,
+    ...userOptions
+  });
+}
+
+exports.defineConfig = defineConfig;

package/dist/defineConfig.mjs

@@ -0,0 +1 @@
+export { defineConfig } from './chunk-OUAGRIOH.mjs';

package/dist/dev.d.ts

@@ -1,6 +1,16 @@
-import * as tsup from 'tsup';
-import { DefineConfigOptions } from './mergeConfigs.js';
+import { Options } from 'tsup';
+import { DefineConfigOptions } from './defineConfig.js';
 
-declare function defineDevConfig(config?: DefineConfigOptions): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+declare const DefaultDevOptions: {
+    dts: true;
+    watch: true;
+    entry: string[];
+    outDir: string;
+    format: string;
+    target: "esnext";
+    platform: "browser";
+    sourcemap: "inline";
+};
+declare function defineDevConfig(options?: DefineConfigOptions): Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
 
-export { defineDevConfig };
+export { DefaultDevOptions, defineDevConfig };

package/dist/dev.js

@@ -1,2 +1,48 @@
-export { a as defineDevConfig } from './chunk-Q2XGPH6E.js';
-import './chunk-KJNVYY35.js';
+'use strict';
+
+var tsup = require('tsup');
+
+// src/defineConfig.ts
+function defineConfig(baseOptions, userOptions) {
+  if (!userOptions || Array.isArray(userOptions) && userOptions.length === 0) {
+    return tsup.defineConfig(baseOptions);
+  }
+  if (typeof userOptions === "function") {
+    return tsup.defineConfig((...args) => ({
+      ...baseOptions,
+      ...userOptions(...args)
+    }));
+  }
+  if (Array.isArray(userOptions)) {
+    return tsup.defineConfig(
+      userOptions.map((configItem) => {
+        return {
+          ...baseOptions,
+          ...configItem
+        };
+      })
+    );
+  }
+  return tsup.defineConfig({
+    ...baseOptions,
+    ...userOptions
+  });
+}
+
+// src/dev.ts
+var DefaultDevOptions = {
+  dts: true,
+  watch: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser",
+  sourcemap: "inline"
+};
+function defineDevConfig(options) {
+  return defineConfig(DefaultDevOptions, options);
+}
+
+exports.DefaultDevOptions = DefaultDevOptions;
+exports.defineDevConfig = defineDevConfig;

package/dist/dev.mjs

@@ -0,0 +1,2 @@
+export { DefaultDevOptions, defineDevConfig } from './chunk-TG5YPRC3.mjs';
+import './chunk-OUAGRIOH.mjs';

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { defineBuildConfig } from './build.js';
-export { defineDevConfig } from './dev.js';
-export { DefineConfigOptions } from './mergeConfigs.js';
+export { DefaultBuildOptions, defineBuildConfig } from './build.js';
+export { DefineConfigOptions } from './defineConfig.js';
+export { DefaultDevOptions, defineDevConfig } from './dev.js';
 import 'tsup';

package/dist/index.js

@@ -1,3 +1,65 @@
-export { a as defineBuildConfig } from './chunk-VN7SD7ZN.js';
-export { a as defineDevConfig } from './chunk-Q2XGPH6E.js';
-import './chunk-KJNVYY35.js';
+'use strict';
+
+var tsup = require('tsup');
+
+// src/defineConfig.ts
+function defineConfig(baseOptions, userOptions) {
+  if (!userOptions || Array.isArray(userOptions) && userOptions.length === 0) {
+    return tsup.defineConfig(baseOptions);
+  }
+  if (typeof userOptions === "function") {
+    return tsup.defineConfig((...args) => ({
+      ...baseOptions,
+      ...userOptions(...args)
+    }));
+  }
+  if (Array.isArray(userOptions)) {
+    return tsup.defineConfig(
+      userOptions.map((configItem) => {
+        return {
+          ...baseOptions,
+          ...configItem
+        };
+      })
+    );
+  }
+  return tsup.defineConfig({
+    ...baseOptions,
+    ...userOptions
+  });
+}
+
+// src/build.ts
+var DefaultBuildOptions = {
+  clean: true,
+  dts: true,
+  treeshake: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser"
+};
+function defineBuildConfig(options) {
+  return defineConfig(DefaultBuildOptions, options);
+}
+
+// src/dev.ts
+var DefaultDevOptions = {
+  dts: true,
+  watch: true,
+  entry: ["./src"],
+  outDir: "./dist",
+  format: "esm",
+  target: "esnext",
+  platform: "browser",
+  sourcemap: "inline"
+};
+function defineDevConfig(options) {
+  return defineConfig(DefaultDevOptions, options);
+}
+
+exports.DefaultBuildOptions = DefaultBuildOptions;
+exports.DefaultDevOptions = DefaultDevOptions;
+exports.defineBuildConfig = defineBuildConfig;
+exports.defineDevConfig = defineDevConfig;

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { DefaultBuildOptions, defineBuildConfig } from './chunk-AJHZ7CZ5.mjs';
+export { DefaultDevOptions, defineDevConfig } from './chunk-TG5YPRC3.mjs';
+import './chunk-OUAGRIOH.mjs';

package/package.json

@@ -2,10 +2,8 @@
   "name": "@workleap/tsup-configs",
   "author": "Workleap",
   "description": "Workleap's recommended tsup configs.",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "license": "Apache-2.0",
-  "type": "module",
-  "sideEffects": false,
   "keywords": [
     "workleap",
     "tsup",
@@ -16,16 +14,30 @@
     "url": "git+https://github.com/workleap/wl-web-configs.git",
     "directory": "packages/tsup-configs"
   },
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
     "dist",
     "CHANGELOG.md",
     "README.md"
   ],
   "devDependencies": {
+    "@swc/core": "1.3.62",
+    "@swc/helpers": "0.5.1",
+    "@swc/jest": "0.2.26",
+    "@types/jest": "29.5.2",
+    "jest": "29.5.0",
+    "ts-node": "10.9.1",
     "tsup": "6.7.0",
-    "@workleap/typescript-configs": "2.3.0"
+    "typescript": "5.0.4",
+    "@workleap/eslint-plugin": "1.8.2",
+    "@workleap/swc-configs": "1.0.0",
+    "@workleap/typescript-configs": "2.3.2"
   },
   "peerDependencies": {
     "tsup": "*"

package/dist/chunk-KJNVYY35.js

@@ -1,5 +0,0 @@
-import { defineConfig } from 'tsup';
-
-function p(e,r){return e===void 0||Array.isArray(e)&&e.length===0?defineConfig(r):typeof e=="function"?defineConfig(n=>({...r,...e(n)})):Array.isArray(e)?defineConfig(e.map(n=>({...r,...n}))):defineConfig({...r,...e})}
-
-export { p as a };

package/dist/chunk-Q2XGPH6E.js

@@ -1,5 +0,0 @@
-import { a } from './chunk-KJNVYY35.js';
-
-function n(t){return a(t,{watch:!0,dts:!0,entry:["./src"],outDir:"./dist",format:["esm"],target:"esnext",platform:"browser",sourcemap:"inline"})}
-
-export { n as a };

package/dist/chunk-VN7SD7ZN.js

@@ -1,5 +0,0 @@
-import { a } from './chunk-KJNVYY35.js';
-
-function i(t){return a(t,{clean:!0,treeshake:!0,minify:!0,dts:!0,entry:["./src"],outDir:"./dist",format:["esm"],target:"esnext",platform:"browser"})}
-
-export { i as a };

package/dist/mergeConfigs.d.ts

@@ -1,6 +0,0 @@
-import { defineConfig, Options } from 'tsup';
-
-type DefineConfigOptions = Parameters<typeof defineConfig>[0];
-declare function mergeConfigs(config: DefineConfigOptions | undefined, baseConfig: Options): ReturnType<typeof defineConfig>;
-
-export { DefineConfigOptions, mergeConfigs };

package/dist/mergeConfigs.js

@@ -1 +0,0 @@
-export { a as mergeConfigs } from './chunk-KJNVYY35.js';