Add cjs-specific output and types (#122)

* add cjs-specific output and types

* update README

* Release 4.2.0-beta.0

* fix scripts

* Release 4.2.0-beta.1

* update CHANGELOG

Author: planttheidea

.gitignore

@@ -2,6 +2,7 @@
 .nyc_output
 .yarn
 coverage
+cjs
 dist
 es
 node_modules

CHANGELOG.md

@@ -1,5 +1,9 @@
 # micro-memoize CHANGELOG
 
+## 4.2.0
+
+- [#122](https://github.com/planttheidea/micro-memoize/pull/122) - Add CJS import for CommonJS requires
+
 ## 4.1.3
 
 - [#121](https://github.com/planttheidea/micro-memoize/pull/121) - Avoid reference to broken source maps (fix for [#79](https://github.com/planttheidea/micro-memoize/issues/79))

README.md

@@ -47,18 +47,26 @@ ESM in browsers:
 import memoize from 'micro-memoize';
 ```
 
-ESM in NodeJS:
+CommonJS:
+
+```ts
+const memoize = require('micro-memoize');
+```
+
+MJS import:
 
 ```ts
 import memoize from 'micro-memoize/mjs';
 ```
 
-CommonJS:
+CJS require:
 
 ```ts
-const memoize = require('micro-memoize');
+const memoize = require('micro-memoize/cjs');
 ```
 
+Note: This is mainly used when `moduleResolution` is set to `Node16` / `NodeNext` in TS projects.
+
 ## Usage
 
 ```ts

package.json

@@ -83,11 +83,13 @@
   },
   "scripts": {
     "benchmark": "npm run dist && NODE_ENV=production node ./benchmarks/index.cjs",
-    "build": "NODE_ENV=production rollup -c config/rollup.config.js --bundleConfigAsCjs",
-    "build:mjs": "node scripts/es-to-mjs.js",
+    "build": "npm run build:bundle && npm run build:mjs && npm run build:cjs",
+    "build:bundle": "NODE_ENV=production rollup -c config/rollup.config.js --bundleConfigAsCjs",
+    "build:cjs": "node scripts/create-cjs-import.js",
+    "build:mjs": "node scripts/create-mjs-import.js",
     "clean": "rm -rf dist && rm -rf mjs",
     "dev": "NODE_ENV=development webpack-dev-server --config=webpack/webpack.config.js",
-    "dist": "npm run clean && npm run build && npm run build:mjs",
+    "dist": "npm run clean && npm run build",
     "lint": "ESLINT_USE_FLAT_CONFIG=false eslint src/*.ts --max-warnings 0",
     "lint:fix": "ESLINT_USE_FLAT_CONFIG=false npm run lint -- --fix",
     "prepublish": "if in-publish; then npm run prepublish:compile; fi",
@@ -102,5 +104,5 @@
   },
   "sideEffects": false,
   "types": "./index.d.ts",
-  "version": "4.1.3"
+  "version": "4.2.0-beta.1"
 }

scripts/create-cjs-import.js

@@ -0,0 +1,53 @@
+const fs = require('fs');
+const path = require('path');
+
+const pkg = require('../package.json');
+
+const BASE_PATH = path.resolve(__dirname, '..');
+const SOURCE_ENTRY = path.join(BASE_PATH, pkg.main);
+const SOURCE_TYPES = path.join(BASE_PATH, 'index.d.ts');
+const DESTINATION = 'cjs';
+const DESTINATION_ENTRY = path.join(BASE_PATH, DESTINATION, 'index.cjs');
+const DESTINATION_TYPES = path.join(BASE_PATH, DESTINATION, 'index.d.cts');
+
+function getFilename(filename) {
+  return filename.replace(`${BASE_PATH}/`, '');
+}
+
+try {
+  if (!fs.existsSync(path.join(BASE_PATH, DESTINATION))) {
+    fs.mkdirSync(path.join(BASE_PATH, DESTINATION));
+  }
+
+  fs.copyFileSync(SOURCE_ENTRY, DESTINATION_ENTRY);
+
+  const contents = fs
+    .readFileSync(DESTINATION_ENTRY, { encoding: 'utf8' })
+    .replace(/\/\/# sourceMappingURL=(.*)/, (match, value) =>
+      match.replace(value, 'index.cjs.map'),
+    );
+
+  fs.writeFileSync(DESTINATION_ENTRY, contents, { encoding: 'utf8' });
+
+  console.log(
+    `Copied ${getFilename(SOURCE_ENTRY)} to ${getFilename(DESTINATION_ENTRY)}`,
+  );
+
+  const types = fs
+    .readFileSync(SOURCE_TYPES, { encoding: 'utf8' })
+    .replace(
+      /export default function memoize/,
+      () => 'declare function memoize',
+    )
+    .concat('\n\nexport = memoize;');
+
+  fs.writeFileSync(DESTINATION_TYPES, types, { encoding: 'utf8' });
+
+  console.log(
+    `Copied ${getFilename(SOURCE_TYPES)} to ${getFilename(DESTINATION_TYPES)}`,
+  );
+} catch (error) {
+  console.error(error);
+
+  process.exit(1);
+}