@workleap/tsup-configs 1.0.1 → 2.0.1

package/CHANGELOG.md

@@ -1,13 +1,25 @@
 # @workleap/tsup-configs
 
+## 2.0.1
+
+### Patch Changes
+
+- [#92](https://github.com/gsoft-inc/wl-web-configs/pull/92) [`66e8f10`](https://github.com/gsoft-inc/wl-web-configs/commit/66e8f1033a987523c65fe9e61f53dac6d2e38777) Thanks [@ofrogon](https://github.com/ofrogon)! - Migrate project from GitHub organization
+
+## 2.0.0
+
+### Major Changes
+
+- [#85](https://github.com/gsoft-inc/wl-web-configs/pull/85) [`bad2df7`](https://github.com/gsoft-inc/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
+- [#74](https://github.com/gsoft-inc/wl-web-configs/pull/74) [`43c9eb1`](https://github.com/gsoft-inc/wl-web-configs/commit/43c9eb11e61896855666c44beb0e711c82a560a3) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Updated installation documentation
 
 ## 1.0.0
 
 ### Major Changes
 
-- [#55](https://github.com/workleap/wl-web-configs/pull/55) [`228dc8c`](https://github.com/workleap/wl-web-configs/commit/228dc8cf3a0b3bc82e7c5380c876284583158599) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Initial release
+- [#55](https://github.com/gsoft-inc/wl-web-configs/pull/55) [`228dc8c`](https://github.com/gsoft-inc/wl-web-configs/commit/228dc8cf3a0b3bc82e7c5380c876284583158599) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Initial release

package/README.md

@@ -7,24 +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
+pnpm add -D @workleap/tsup-configs tsup typescript
 ```
 
 **With yarn**
 
 ```shell
-yarn add -D @workleap/tsup-configs
+yarn add -D @workleap/tsup-configs tsup typescript
 ```
 
 **With npm**
 
 ```shell
-npm install -D @workleap/tsup-configs
+npm install -D @workleap/tsup-configs tsup typescript
 ```
 
 ## Usage
@@ -42,15 +42,63 @@ 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 "@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
@@ -66,6 +114,7 @@ If you want to use additional tsup options or override the default ones, you can
 
 ```ts
 // tsup.config.ts
+
 import { defineBuildConfig } from "@workleap/tsup-configs";
 
 export default defineBuildConfig({
@@ -76,6 +125,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, this 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/applyTransformers.d.ts

@@ -0,0 +1,9 @@
+import { Options } from 'tsup';
+
+interface TsupConfigTransformerContext {
+    environment: "dev" | "build";
+}
+type TsupConfigTransformer = (config: Options, context: TsupConfigTransformerContext) => Options;
+declare function applyTransformers(config: Options, transformers: TsupConfigTransformer[], context: TsupConfigTransformerContext): Options;
+
+export { TsupConfigTransformer, TsupConfigTransformerContext, applyTransformers };

package/dist/applyTransformers.js

@@ -0,0 +1,8 @@
+'use strict';
+
+// src/applyTransformers.ts
+function applyTransformers(config, transformers, context) {
+  return transformers.reduce((acc, transformer) => transformer(acc, context), config);
+}
+
+exports.applyTransformers = applyTransformers;

package/dist/applyTransformers.mjs

@@ -0,0 +1 @@
+export { applyTransformers } from './chunk-3UBBOKDF.mjs';

package/dist/build.d.ts

@@ -1,6 +1,9 @@
-import * as tsup from 'tsup';
-import { DefineConfigOptions } from './mergeConfigs.js';
+import { Options } from 'tsup';
+import { TsupConfigTransformer } from './applyTransformers.js';
 
-declare function defineBuildConfig(config?: DefineConfigOptions): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+interface DefineBuildConfigOptions extends Options {
+    transformers?: TsupConfigTransformer[];
+}
+declare function defineBuildConfig(options?: DefineBuildConfigOptions): Options;
 
-export { defineBuildConfig };
+export { DefineBuildConfigOptions, defineBuildConfig };

package/dist/build.js

@@ -1,48 +1,31 @@
-import { defineConfig } from 'tsup';
+'use strict';
 
-// src/mergeConfigs.ts
-function mergeConfigs(config, baseConfig) {
-  if (config === void 0 || Array.isArray(config) && config.length === 0) {
-    return defineConfig(baseConfig);
-  }
-  if (typeof config === "function") {
-    return defineConfig((cliFlags) => {
-      return {
-        ...baseConfig,
-        ...config(cliFlags)
-      };
-    });
-  } else if (Array.isArray(config)) {
-    return defineConfig(
-      config.map((configItem) => {
-        return {
-          ...baseConfig,
-          ...configItem
-        };
-      })
-    );
-  } else {
-    return defineConfig({
-      ...baseConfig,
-      ...config
-    });
-  }
+// src/applyTransformers.ts
+function applyTransformers(config, transformers, context) {
+  return transformers.reduce((acc, transformer) => transformer(acc, context), config);
 }
 
 // src/build.ts
-function defineBuildConfig(config) {
-  return mergeConfigs(config, {
+function defineBuildConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
     clean: true,
     dts: true,
-    minify: true,
-    splitting: false,
     treeshake: true,
     entry: ["./src"],
     outDir: "./dist",
-    format: ["esm"],
+    format: "esm",
     target: "esnext",
-    platform: "browser"
+    platform: "browser",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "build"
   });
+  return transformedConfig;
 }
 
-export { defineBuildConfig };
+exports.defineBuildConfig = defineBuildConfig;

package/dist/build.mjs

@@ -0,0 +1,2 @@
+export { defineBuildConfig } from './chunk-JENCWRR7.mjs';
+import './chunk-3UBBOKDF.mjs';

package/dist/chunk-3UBBOKDF.mjs

@@ -0,0 +1,6 @@
+// src/applyTransformers.ts
+function applyTransformers(config, transformers, context) {
+  return transformers.reduce((acc, transformer) => transformer(acc, context), config);
+}
+
+export { applyTransformers };

package/dist/chunk-DQ32U23F.mjs

@@ -0,0 +1,26 @@
+import { applyTransformers } from './chunk-3UBBOKDF.mjs';
+
+// src/dev.ts
+function defineDevConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
+    dts: true,
+    watch: true,
+    entry: ["./src"],
+    outDir: "./dist",
+    format: "esm",
+    target: "esnext",
+    platform: "browser",
+    sourcemap: "inline",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "dev"
+  });
+  return transformedConfig;
+}
+
+export { defineDevConfig };

package/dist/chunk-JENCWRR7.mjs

@@ -0,0 +1,26 @@
+import { applyTransformers } from './chunk-3UBBOKDF.mjs';
+
+// src/build.ts
+function defineBuildConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
+    clean: true,
+    dts: true,
+    treeshake: true,
+    entry: ["./src"],
+    outDir: "./dist",
+    format: "esm",
+    target: "esnext",
+    platform: "browser",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "build"
+  });
+  return transformedConfig;
+}
+
+export { defineBuildConfig };

package/dist/dev.d.ts

@@ -1,6 +1,9 @@
-import * as tsup from 'tsup';
-import { DefineConfigOptions } from './mergeConfigs.js';
+import { Options } from 'tsup';
+import { TsupConfigTransformer } from './applyTransformers.js';
 
-declare function defineDevConfig(config?: DefineConfigOptions): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+interface DefineDevConfigOptions extends Options {
+    transformers?: TsupConfigTransformer[];
+}
+declare function defineDevConfig(options?: DefineDevConfigOptions): Options;
 
-export { defineDevConfig };
+export { DefineDevConfigOptions, defineDevConfig };

package/dist/dev.js

@@ -1,47 +1,31 @@
-import { defineConfig } from 'tsup';
+'use strict';
 
-// src/mergeConfigs.ts
-function mergeConfigs(config, baseConfig) {
-  if (config === void 0 || Array.isArray(config) && config.length === 0) {
-    return defineConfig(baseConfig);
-  }
-  if (typeof config === "function") {
-    return defineConfig((cliFlags) => {
-      return {
-        ...baseConfig,
-        ...config(cliFlags)
-      };
-    });
-  } else if (Array.isArray(config)) {
-    return defineConfig(
-      config.map((configItem) => {
-        return {
-          ...baseConfig,
-          ...configItem
-        };
-      })
-    );
-  } else {
-    return defineConfig({
-      ...baseConfig,
-      ...config
-    });
-  }
+// src/applyTransformers.ts
+function applyTransformers(config, transformers, context) {
+  return transformers.reduce((acc, transformer) => transformer(acc, context), config);
 }
 
 // src/dev.ts
-function defineDevConfig(config) {
-  return mergeConfigs(config, {
+function defineDevConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
     dts: true,
-    splitting: false,
     watch: true,
     entry: ["./src"],
     outDir: "./dist",
-    format: ["esm"],
+    format: "esm",
     target: "esnext",
     platform: "browser",
-    sourcemap: "inline"
+    sourcemap: "inline",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "dev"
   });
+  return transformedConfig;
 }
 
-export { defineDevConfig };
+exports.defineDevConfig = defineDevConfig;

package/dist/dev.mjs

@@ -0,0 +1,2 @@
+export { defineDevConfig } from './chunk-DQ32U23F.mjs';
+import './chunk-3UBBOKDF.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 { TsupConfigTransformer, TsupConfigTransformerContext } from './applyTransformers.js';
+export { DefineBuildConfigOptions, defineBuildConfig } from './build.js';
+export { DefineDevConfigOptions, defineDevConfig } from './dev.js';
 import 'tsup';

package/dist/index.js

@@ -1,63 +1,55 @@
-import { defineConfig } from 'tsup';
+'use strict';
 
-// src/mergeConfigs.ts
-function mergeConfigs(config, baseConfig) {
-  if (config === void 0 || Array.isArray(config) && config.length === 0) {
-    return defineConfig(baseConfig);
-  }
-  if (typeof config === "function") {
-    return defineConfig((cliFlags) => {
-      return {
-        ...baseConfig,
-        ...config(cliFlags)
-      };
-    });
-  } else if (Array.isArray(config)) {
-    return defineConfig(
-      config.map((configItem) => {
-        return {
-          ...baseConfig,
-          ...configItem
-        };
-      })
-    );
-  } else {
-    return defineConfig({
-      ...baseConfig,
-      ...config
-    });
-  }
+// src/applyTransformers.ts
+function applyTransformers(config, transformers, context) {
+  return transformers.reduce((acc, transformer) => transformer(acc, context), config);
 }
 
 // src/build.ts
-function defineBuildConfig(config) {
-  return mergeConfigs(config, {
+function defineBuildConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
     clean: true,
     dts: true,
-    minify: true,
-    splitting: false,
     treeshake: true,
     entry: ["./src"],
     outDir: "./dist",
-    format: ["esm"],
+    format: "esm",
     target: "esnext",
-    platform: "browser"
+    platform: "browser",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "build"
   });
+  return transformedConfig;
 }
 
 // src/dev.ts
-function defineDevConfig(config) {
-  return mergeConfigs(config, {
+function defineDevConfig(options = {}) {
+  const {
+    transformers = [],
+    ...rest
+  } = options;
+  const config = {
     dts: true,
-    splitting: false,
     watch: true,
     entry: ["./src"],
     outDir: "./dist",
-    format: ["esm"],
+    format: "esm",
     target: "esnext",
     platform: "browser",
-    sourcemap: "inline"
+    sourcemap: "inline",
+    ...rest
+  };
+  const transformedConfig = applyTransformers(config, transformers, {
+    environment: "dev"
   });
+  return transformedConfig;
 }
 
-export { defineBuildConfig, defineDevConfig };
+exports.defineBuildConfig = defineBuildConfig;
+exports.defineDevConfig = defineDevConfig;

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { defineBuildConfig } from './chunk-JENCWRR7.mjs';
+export { defineDevConfig } from './chunk-DQ32U23F.mjs';
+import './chunk-3UBBOKDF.mjs';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@workleap/tsup-configs",
   "author": "Workleap",
   "description": "Workleap's recommended tsup configs.",
-  "version": "1.0.1",
+  "version": "2.0.1",
   "license": "Apache-2.0",
   "keywords": [
     "workleap",
@@ -11,14 +11,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/workleap/wl-web-configs.git",
+    "url": "git+https://github.com/gsoft-inc/wl-web-configs.git",
     "directory": "packages/tsup-configs"
   },
-  "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
     }
   },
   "files": [
@@ -26,14 +27,22 @@
     "CHANGELOG.md",
     "README.md"
   ],
+  "peerDependencies": {
+    "tsup": "*",
+    "typescript": "*"
+  },
   "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",
     "typescript": "5.0.4",
-    "@workleap/eslint-plugin": "1.8.1",
-    "@workleap/typescript-configs": "2.3.1"
-  },
-  "peerDependencies": {
-    "tsup": "*"
+    "@workleap/eslint-plugin": "1.8.3",
+    "@workleap/swc-configs": "1.0.1",
+    "@workleap/typescript-configs": "2.3.3"
   },
   "publishConfig": {
     "access": "public",

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,32 +0,0 @@
-import { defineConfig } from 'tsup';
-
-// src/mergeConfigs.ts
-function mergeConfigs(config, baseConfig) {
-  if (config === void 0 || Array.isArray(config) && config.length === 0) {
-    return defineConfig(baseConfig);
-  }
-  if (typeof config === "function") {
-    return defineConfig((cliFlags) => {
-      return {
-        ...baseConfig,
-        ...config(cliFlags)
-      };
-    });
-  } else if (Array.isArray(config)) {
-    return defineConfig(
-      config.map((configItem) => {
-        return {
-          ...baseConfig,
-          ...configItem
-        };
-      })
-    );
-  } else {
-    return defineConfig({
-      ...baseConfig,
-      ...config
-    });
-  }
-}
-
-export { mergeConfigs };