chore: using new build setup to output both esm and umd builds

Author: tusharf5

.gitignore

@@ -1,4 +1,4 @@
 node_modules
-lib
+dist
 npm-debug.log
 .vscode

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## v2.0.0-beta.1
+
+Migrating to this version might require a few of the users you to channge the way how they were importing the libray.
+
+- **[Breaking Change]** Changed the output dir from `lib` to `build`
+- **[Breaking Change]** Added separate esm and umd builds
+- **[Breaking Change]** Removed the `options.strategy` option

README.md

@@ -43,7 +43,6 @@ Calling the `createStore` function returns an object with the following properti
 | Property      | Description                                                                                           | Type                            | Default |
 | ------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------- | ------- |
 | `timeToClear` | Time in **milliseconds** for which the store will keep an item when the policy is `timeout` or `tlru` | Number                          | 7200000 |
-| `strategy`    | **Deprecated - use policy option**                                                                    | -                               | -       |
 | `policy`      | A Policy to evict items from the store                                                                | `timeout`, `lru`, `mru`, `tlru` | `lru`   |
 | `lruSize`     | Size of the cache store when the policy is `lru` or `tlru`                                            | Number                          | 500     |
 | `mruSize`     | Size of the cache store when the policy is `mru`                                                      | Number                          | 500     |
@@ -129,7 +128,7 @@ async function loginUser(userId: string) {
 - `npm run test` -- Runs tests, lint and build.
 - `npm run lint` -- Runs ESLint.
 - `npm run format` -- Reformats all of the `.ts` and `.tsx` files with Prettier.
-- `npm run build` -- Regenerates `lib` folder that gets included into NPM module.
+- `npm run build` -- Regenerates `dist` folder that gets included into NPM module.
 
 ## Todos
 

package.json

@@ -1,8 +1,14 @@
 {
   "name": "runtime-memcache",
-  "version": "1.3.1",
+  "version": "2.0.0-beta.1",
   "description": "A no dependency javascript runtime key-value cache store for small chunks of arbitrary data (strings, objects, numbers)",
   "homepage": "https://github.com/tusharf5/runtime-memcache",
+  "main": "./dist/umd/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/tusharf5/runtime-memcache"
@@ -17,11 +23,11 @@
     "dev": "yarn build && yarn test",
     "lint": "eslint 'src/**/*.{ts}' 'tests/**/*.{ts}'",
     "format": "npx prettier --write '**/*.{ts,js,json}'",
-    "build": "rm -rf lib && tsc -p . && rm -rf lib/tests && rm -rf lib/src",
+    "build": "webpack --mode=production",
+    "prebuild": "rm -rf dist && tsc -p . && rm -rf dist/tests && rm -rf dist/src",
     "prepublish": "npm run build && npm run test"
   },
   "license": "MIT",
-  "main": "lib/index.js",
   "keywords": [
     "js cache",
     "javascript cache",
@@ -34,13 +40,10 @@
     "timeout",
     "mru"
   ],
-  "typings": "lib/index.d.ts",
-  "files": [
-    "lib/"
-  ],
   "devDependencies": {
     "@types/jest": "^25.2.1",
     "@types/node": "^13.11.0",
+    "babel-loader": "^8.1.0",
     "eslint": "^6.8.0",
     "eslint-config-airbnb": "^18.0.1",
     "eslint-config-prettier": "^6.10.1",
@@ -55,6 +58,8 @@
     "prettier": "^2.0.2",
     "ts-node": "^8.8.2",
     "typescript": "^3.8.3",
-    "typescript-eslint-parser": "^22.0.0"
+    "typescript-eslint-parser": "^22.0.0",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11"
   }
 }

src/store.ts

@@ -20,12 +20,7 @@ function createStore<K extends string | number | symbol = string, V = any>(
   if (typeof userConfig === 'object') {
     userConfigVerf = userConfig;
   }
-  if (userConfigVerf.strategy) {
-    userConfigVerf.policy = userConfigVerf.policy || userConfigVerf.strategy;
-    console.warn(
-      'runtime-memcache:: Use the `policy` config option instead of `strategy`. `strategy` option is deprecated and will be removed in the next major version',
-    );
-  }
+
   const config: Required<GlobalConfig> = Object.assign({}, defaultConfig, userConfigVerf);
 
   switch (config.policy) {

tests/index.test.js

@@ -1,4 +1,4 @@
-const createStore = require('../lib/index').default;
+const createStore = require('../dist/esm/index').default;
 
 jest.setTimeout(30000);
 

tsconfig.json

@@ -1,16 +1,18 @@
 {
   "compilerOptions": {
-    "outDir": "lib/",
+    "outDir": "./dist/esm/",
     "sourceMap": true,
     "module": "commonjs",
     "moduleResolution": "node",
     "noEmitOnError": true,
-    "target": "es5",
+    "target": "es6",
     "declaration": true,
     "removeComments": false,
     "noImplicitAny": true,
     "forceConsistentCasingInFileNames": true,
     "noUnusedLocals": true,
     "pretty": true
-  }
+  },
+  "files": ["./src/index.ts"],
+  "include": ["./src/**/*.ts"]
 }

webpack.config.js

@@ -0,0 +1,20 @@
+const path = require('path');
+
+module.exports = (env, argv) => {
+  return {
+    entry: {
+      index: path.resolve(__dirname, './dist/esm/index.js'),
+    },
+    output: {
+      path: path.resolve(__dirname, './dist/umd'), // builds to ./dist/umd/
+      filename: '[name].js', // index.js
+      library: 'myLibrary', // aka window.myLibrary
+      libraryTarget: 'umd', // supports commonjs, amd and web browsers
+      globalObject: 'this',
+      libraryExport: 'default',
+    },
+    module: {
+      rules: [{ test: /\.t|js$/, use: 'babel-loader' }],
+    },
+  };
+};