@workleap/tsup-configs 2.0.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @workleap/tsup-configs
 
+## 3.0.0
+
+### Major Changes
+
+- [#98](https://github.com/gsoft-inc/wl-web-configs/pull/98) [`56ca32e`](https://github.com/gsoft-inc/wl-web-configs/commit/56ca32ee3194c51210aacc5189f3ebbec5a4a7b6) Thanks [@patricklafrance](https://github.com/patricklafrance)! - New start, every package has a major version bump
+
 ## 2.0.1
 
 ### Patch Changes

package/README.md

@@ -1,133 +1,19 @@
 # @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)
 [![npm version](https://img.shields.io/npm/v/@workleap/tsup-configs)](https://www.npmjs.com/package/@workleap/tsup-configs)
 
-## Installation
-
-Install the following packages:
-
-**With pnpm**
-
-```shell
-pnpm add -D @workleap/tsup-configs tsup typescript
-```
-
-**With yarn**
-
-```shell
-yarn add -D @workleap/tsup-configs tsup typescript
-```
-
-**With npm**
-
-```shell
-npm install -D @workleap/tsup-configs tsup typescript
-```
-
 ## Usage
 
-To build your React or TypeScript library project, follow these steps:
-
-1. Create two files at the top of your project: `tsup.dev.ts` and `tsup.build.ts`.
-
-2. Open the `tsup.dev.ts` file and add the following code:
-
-```ts
-// tsup.dev.ts
-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]
-});
-```
+View the [user's documentation](https://gsoft-inc.github.io/wl-web-configs/).
 
-3. Open the `tsup.build.ts` file and add the following code:
+## 🤝 Contributing
 
-```ts
-// tsup.build.ts
+View the [contributor's documentation](../../CONTRIBUTING.md).
 
-import { defineBuildConfig } from "@workleap/tsup-configs";
+### Notes
 
-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
-"dev": "tsup --config ./tsup.dev.ts",
-"build": "tsup --config ./tsup.build.ts"
-```
-
-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 "@workleap/tsup-configs";
-
-export default defineBuildConfig({
-    entry: ["lib/index.ts"],
-    format: ["cjs"]
-});
-```
-
-[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
+#### 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.
 
@@ -135,4 +21,5 @@ 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.
+Copyright © 2023, Workleap. 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/workleap-license/blob/master/LICENSE.
+

package/dist/index.d.ts

@@ -1,4 +1,4 @@
+export { Options as TsupConfig } from 'tsup';
 export { TsupConfigTransformer, TsupConfigTransformerContext } from './applyTransformers.js';
 export { DefineBuildConfigOptions, defineBuildConfig } from './build.js';
 export { DefineDevConfigOptions, defineDevConfig } from './dev.js';
-import 'tsup';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@workleap/tsup-configs",
   "author": "Workleap",
   "description": "Workleap's recommended tsup configs.",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "license": "Apache-2.0",
   "keywords": [
     "workleap",
@@ -40,9 +40,9 @@
     "ts-node": "10.9.1",
     "tsup": "6.7.0",
     "typescript": "5.0.4",
-    "@workleap/eslint-plugin": "1.8.3",
-    "@workleap/swc-configs": "1.0.1",
-    "@workleap/typescript-configs": "2.3.3"
+    "@workleap/eslint-plugin": "2.0.0",
+    "@workleap/swc-configs": "2.0.0",
+    "@workleap/typescript-configs": "3.0.0"
   },
   "publishConfig": {
     "access": "public",