build: add exports configuration

sibiraj-s · Oct 25, 2023 · bc6d65f · bc6d65f
1 parent 6de173d
commit bc6d65f
Show file tree

Hide file tree

Showing 5 changed files with 182 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -16,21 +16,13 @@ yarn add browser-dtector
 
 or use cdn
 
-**Minified:**
-
-```bash
-//cdn.jsdelivr.net/npm/browser-dtector@latest/browser-dtector.esm.min.js
-```
-
-**Pretty Printed:**
-
 ```bash
-//cdn.jsdelivr.net/npm/browser-dtector@latest/browser-dtector.esm.js
+//cdn.jsdelivr.net/npm/browser-dtector@latest/dist/browser-dtector.js
 ```
 
 ### Usage
 
-This library is compiled to [UMD][umd] format, you should be able to use it in both `Node.js` and `browser`.
+This library exports both ESM and CJS formats, you should be able to use it in both `Node.js` and `browser`.
 
 ```js
 import BrowserDetector from 'browser-dtector';
@@ -45,7 +37,7 @@ _Note_: while using in nodejs, it is mandatory to input `useragent`.
 
 ```js
 const http = require('http');
-const BrowserDetector = require('browser-dtector');
+const { BrowserDetector } = require('browser-dtector');
 
 const browser = new BrowserDetector();
 
@@ -76,7 +68,7 @@ console.log('Server running at http://127.0.0.1:8080/');
   <body>
     Hello World!
     <script type="module">
-      import BrowserDetector from 'https://cdn.jsdelivr.net/npm/browser-dtector/browser-dtector.esm.js';
+      import BrowserDetector from 'https://cdn.jsdelivr.net/npm/browser-dtector/dist/browser-dtector.js';
 
       const detector = new BrowserDetector(window.navigator.userAgent);
       console.log(detector.parseUserAgent());

diff --git a/lib/browser-dtector.ts b/lib/browser-dtector.ts
@@ -160,4 +160,5 @@ class BrowserDetector {
   }
 }
 
+export { KnownBrowsers, KnownPlatforms, BrowserDetector };
 export default BrowserDetector;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,12 +5,31 @@
   "author": "sibiraj-s",
   "license": "MIT",
   "private": true,
+  "type": "module",
   "repository": "https://github.com/sibiraj-s/browser-dtector.git",
   "homepage": "https://github.com/sibiraj-s/browser-dtector#readme",
   "bugs": "https://github.com/sibiraj-s/browser-dtector/issues",
   "engines": {
     "node": ">=16"
   },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/browser-dtector.cjs",
+  "module": "./dist/browser-dtector.js",
+  "types": "./dist/browser-dtector.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/browser-dtector.d.cts",
+        "default": "./dist/browser-dtector.cjs"
+      },
+      "import": "./dist/browser-dtector.js",
+      "types": "./dist/browser-dtector.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "tsup",
     "build:docs": "vite build --base /browser-dtector/",
@@ -38,6 +57,7 @@
     "husky": "^8.0.3",
     "is-ci": "^3.0.1",
     "lint-staged": "^15.0.2",
+    "publint": "^0.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router-dom": "^6.17.0",

diff --git a/tsup.config.ts b/tsup.config.ts
@@ -6,5 +6,7 @@ export default defineConfig({
   sourcemap: true,
   clean: true,
   outDir: 'dist',
-  format: ['cjs', 'esm', 'iife'],
+  format: ['esm', 'cjs'],
+  dts: true,
+  minify: process.env.CI === 'true',
 });