Merge pull request #643 from soluble-io/redis-esm-first

[cache-redis] esm first, dual packaging cjs/esm

Author: belgattitude

.changeset/tasty-comics-wonder.md

@@ -0,0 +1,5 @@
+---
+'@soluble/cache-redis': minor
+---
+
+ESM first, dual packaging supported (esm/cjs)

packages/cache-redis/.escheckrc

@@ -1,5 +1,5 @@
 {
-  "ecmaVersion": "es2017",
+  "ecmaVersion": "es2020",
   "module": true,
   "files": "./dist/**/*.js"
 }

packages/cache-redis/.size-limit.cjs

@@ -0,0 +1,7 @@
+module.exports = [
+  {
+    name: 'JS',
+    path: ['dist/index.js'],
+    limit: '2.5KB',
+  },
+];

packages/cache-redis/.size-limit.js

@@ -1,50 +1,54 @@
 // @ts-check
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { getTsconfig } from 'get-tsconfig';
+import { getJestCachePath } from '../../cache.config.js';
 
-const { defaults: tsPreset } = require('ts-jest/presets');
-const { pathsToModuleNameMapper } = require('ts-jest');
+const tsConfigFile = new URL('./tsconfig.jest.json', import.meta.url).pathname;
 
-const {
-  compilerOptions: { paths: tsConfigPaths },
-} = require('../../tsconfig.paths.json');
-
-// Take the paths from tsconfig automatically from base tsconfig.json
-// @link https://kulshekhar.github.io/ts-jest/docs/paths-mapping
-const getTsConfigBasePaths = () => {
-  return tsConfigPaths
-    ? pathsToModuleNameMapper(tsConfigPaths, {
-        prefix: '<rootDir>/tricky-false-path-to-remove-parent/packages',
+/**
+ * Transform the tsconfig paths into jest compatible one (support extends)
+ * @param {string} tsConfigFile
+ */
+const getTsConfigBasePaths = (tsConfigFile) => {
+  const parsedTsConfig = getTsconfig(tsConfigFile);
+  if (parsedTsConfig === null) {
+    throw new Error(`Cannot find tsconfig file: ${tsConfigFile}`);
+  }
+  const tsPaths = parsedTsConfig.config.compilerOptions?.paths;
+  return tsPaths
+    ? pathsToModuleNameMapper(tsPaths, {
+        prefix: '<rootDir>/',
       })
     : {};
 };
 
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/** @type {import('ts-jest/dist').InitialOptionsTsJest} */
 const config = {
-  displayName: 'cache-redis/unit',
-  testRunner: 'jest-circus/runner',
+  displayName: `cache-interop:unit`,
+  preset: 'ts-jest/presets/default-esm',
+  cacheDirectory: getJestCachePath('@soluble/cache-interop'),
   testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
   verbose: true,
-  transform: {
-    ...tsPreset.transform,
-  },
-  rootDir: '../',
-
-  testMatch: ['<rootDir>/cache-redis/src/**/*.test.ts'],
+  rootDir: './src',
+  testMatch: ['<rootDir>/**/*.{spec,test}.{js,jsx,ts,tsx}'],
   moduleNameMapper: {
-    ...getTsConfigBasePaths(),
+    ...getTsConfigBasePaths(tsConfigFile),
   },
-  coverageDirectory: '<rootDir>/cache-redis/coverage',
+  // false by default, overrides in cli, ie: yarn test:unit --collect-coverage=true
+  collectCoverage: false,
+  coverageDirectory: '<rootDir>/../coverage',
   collectCoverageFrom: [
-    '<rootDir>/cache-redis/src/**/*.{ts,js}',
-    '!**/*.test.ts',
-    '!**/index.ts',
-    '!**/*.d.ts',
+    '<rootDir>/**/*.{ts,tsx,js,jsx}',
+    '!**/*.test.{js,ts}',
+    '!**/__mock__/*',
   ],
   globals: {
     'ts-jest': {
-      diagnostics: true,
-      tsconfig: './tsconfig.jest.json',
+      useESM: true,
+      tsconfig: tsConfigFile,
     },
   },
 };
 
-module.exports = config;
+export default config;

packages/cache-redis/jest.config.js

@@ -19,22 +19,25 @@
     "redis",
     "node-redis"
   ],
-  "jsnext:main": "dist/cache-redis.es.js",
-  "source": "src/index.ts",
-  "module": "dist/cache-redis.es.js",
-  "main": "dist/cache-redis.js",
-  "umd:main": "dist/cache-redis.umd.js",
-  "typings": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "sideEffects": false,
   "publishConfig": {
     "directory": "_release/package"
   },
   "scripts": {
-    "start": "cross-env NODE_ENV=development microbundle watch",
-    "build": "rimraf ./dist && cross-env NODE_ENV=production microbundle --tsconfig tsconfig.build.json --format esm,cjs --target node --no-compress && mv dist/cache-redis/src/*.d.ts dist/ && rm -rf dist/cache-redis/src/",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "?build-release": "When https://github.com/atlassian/changesets/issues/432 has a solution we can remove this trick",
     "build-release": "yarn build && rimraf ./_release && yarn pack && mkdir ./_release && tar zxvf ./package.tgz --directory ./_release && rm ./package.tgz",
     "check-size": "size-limit",
@@ -68,8 +71,8 @@
     "@types/redis": "2.8.32",
     "cross-env": "7.0.3",
     "es-check": "7.0.0",
+    "get-tsconfig": "4.2.0",
     "jest": "28.1.3",
-    "microbundle": "0.15.0",
     "redis": "3.1.2",
     "rimraf": "3.0.2",
     "size-limit": "8.0.0",

packages/cache-redis/package.json

@@ -1,13 +1,16 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "target": "ESNext",
+    "target": "ES2020",
     "module": "ESNext",
-    "baseUrl": "./src",
+    "rootDir": "../",
+    "baseUrl": "./cache-redis/src",
     "noEmit": false,
     "declaration": true,
     "declarationMap": false,
-    "declarationDir": "./dist"
+    "declarationDir": "./dist",
+    "tsBuildInfoFile": "./tsconfig.build.tsbuildinfo" // for tsup rollup dts tsBuildInfoFile is required when using incremental
   },
   "exclude": ["*.test.ts"]
 }

packages/cache-redis/tsconfig.build.json

@@ -1,8 +1,9 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "target": "es2017",
-    "module": "commonjs",
+    "target": "ES2020",
+    "module": "ESNext",
     "noImplicitAny": false,
     "declaration": false,
     "noUnusedLocals": false,

packages/cache-redis/tsconfig.jest.json

@@ -0,0 +1,17 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig((options) => {
+  return {
+    entry: ['src/index.ts'],
+    splitting: true,
+    clean: true,
+    dts: true,
+    format: ['esm', 'cjs'],
+    platform: 'node',
+    target: ['node14'],
+    tsconfig: new URL('./tsconfig.build.json', import.meta.url).pathname,
+    sourcemap: !options.watch,
+    // Do not minify node only packages to let patching possible by the consumer (ie: patch-package)
+    minify: false,
+  };
+});