feat!: supported esmodule

.changeset/eighty-windows-arrive.md

@@ -0,0 +1,32 @@
+---
+"@ckb-lumos/common-scripts": minor
+"@ckb-lumos/debugger": minor
+"@ckb-lumos/e2e-test": minor
+"@ckb-lumos/molecule": minor
+"@ckb-lumos/bundler": minor
+"@ckb-lumos/helpers": minor
+"@ckb-lumos/toolkit": minor
+"@ckb-lumos/crypto": minor
+"@ckb-lumos/codec": minor
+"@ckb-lumos/lumos": minor
+"@ckb-lumos/base": minor
+"@ckb-lumos/bi": minor
+"@ckb-lumos/hd": minor
+"@ckb-lumos/ckb-indexer": minor
+"@ckb-lumos/config-manager": minor
+"@ckb-lumos/experiment-tx-assembler": minor
+"@ckb-lumos/hd-cache": minor
+"@ckb-lumos/light-client": minor
+"@ckb-lumos/rpc": minor
+"@ckb-lumos/runner": minor
+"@ckb-lumos/testkit": minor
+"@ckb-lumos/transaction-manager": minor
+"@ckb-lumos/utils": minor
+---
+
+Making it compatible with the ES module specification, if the `moduleResolution` is NOT `node` in your TypeScript project, please update your import path to the following:
+
+```diff
+-import { moduleName } from '@ckb-lumos/pkgName/lib/fileName'
++import { moduleName } from '@ckb-lumos/pkgName[/exportName]'
+```

.eslintrc.js

@@ -16,11 +16,13 @@ module.exports = {
     "SharedArrayBuffer": "readonly"
   },
   "extends": [
-    "plugin:import/recommended", 
+    "plugin:import/recommended",
     "plugin:import/typescript"
   ],
   "rules": {
     "no-var": "error",
+    "import/no-unresolved": "off",
+    "import/no-useless-path-segments": "error",
     "@typescript-eslint/no-unused-vars": [
       "error",
       {

.gitignore

@@ -117,6 +117,8 @@ packages/experiment-tx-assembler/lib
 packages/molecule/lib
 packages/transaction-manager/lib
 
+packages/*/lib.esm
+
 # knex config
 packages/sql-indexer/knexfile.ts
 

.prettierignore

@@ -1 +1,2 @@
-**/test_cases.js
+**/test_cases.js
+devtools/*/bin

babel.config.js

@@ -1,13 +1,23 @@
+const buildCjs = process.env.MODULE === "cjs";
+const buildEsm = process.env.MODULE === "esm";
+
 const presets = [
   [
     "@babel/preset-env",
     {
       targets: {
         chrome: "79",
       },
+      ...(buildEsm ? { modules: false } : {}),
     },
   ],
   "@babel/preset-typescript",
 ];
 
-module.exports = { presets };
+const plugins = [
+  buildCjs && "@babel/plugin-proposal-export-namespace-from",
+  buildCjs && "@babel/plugin-transform-modules-commonjs",
+  require.resolve("babel-plugin-add-import-extension"),
+].filter(Boolean);
+
+module.exports = { presets, plugins: plugins };

commitlint.config.js

@@ -22,6 +22,7 @@ const scopeEnumValues = [
   "utils",
   "runner",
   "e2e-test",
+  "crypto",
 ];
 const Configuration = {
   extends: ["@commitlint/config-conventional"],

devtools/.gitignore

@@ -0,0 +1,2 @@
+lib
+stats.json

devtools/bundler/README.md

@@ -0,0 +1,10 @@
+# Bundler
+
+A Lumos bundler playground to test, check and analyze the bundled code.
+
+## Usage
+
+```bash
+npm run bundle-stats
+npm run bundle-analyze
+```

devtools/bundler/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "bundler",
+  "description": "An example bundler for lumos for analysis",
+  "version": "0.21.0-next.0",
+  "private": true,
+  "homepage": "https://github.com/ckb-js/lumos#readme",
+  "bugs": {
+    "url": "https://github.com/ckb-js/lumos/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ckb-js/lumos.git"
+  },
+  "license": "MIT",
+  "author": "",
+  "scripts": {
+    "bundle-stats": "webpack --profile --json > stats.json",
+    "bundle-analyze": "webpack-bundle-analyzer stats.json"
+  },
+  "dependencies": {
+    "@ckb-lumos/lumos": "canary",
+    "@types/webpack-bundle-analyzer": "^4.6.0",
+    "buffer": "^5.6.0",
+    "fork-ts-checker-webpack-plugin": "^6.4.0",
+    "ts-loader": "^9.4.3",
+    "unminified-webpack-plugin": "^3.0.0",
+    "webpack": "^5.64.1",
+    "webpack-bundle-analyzer": "^4.9.0",
+    "webpack-cli": "^4.9.1"
+  }
+}

devtools/bundler/src/index.ts

@@ -0,0 +1 @@
+export * from "@ckb-lumos/lumos";

devtools/bundler/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+}

devtools/bundler/webpack.config.js

@@ -0,0 +1,39 @@
+const path = require("path");
+const webpack = require("webpack");
+const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
+
+module.exports = {
+  mode: "production",
+  devtool: "source-map",
+  entry: { output: "./src/index.ts" },
+  output: {
+    path: path.join(__dirname, "lib"),
+    filename: "lumos.min.js",
+    library: "lumos",
+    libraryTarget: "umd",
+    globalObject: "this",
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        loader: "ts-loader",
+        options: {},
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".ts", ".js", ".json"],
+    fallback: {
+      // https://www.npmjs.com/package/buffer#usage
+      buffer: require.resolve("buffer/"),
+      path: false,
+      fs: false,
+      stream: false,
+    },
+  },
+  plugins: [
+    new ForkTsCheckerWebpackPlugin({ async: false }),
+    new webpack.ProvidePlugin({ Buffer: ["buffer", "Buffer"] }),
+  ],
+};

devtools/lumos-build/README.md

@@ -0,0 +1,31 @@
+# lumos-build
+
+A package for building ESM and CJS output from a source directory.
+
+## Quick Start
+
+```
+lumos-build --esm --cjs --types
+```
+
+Will build ESM, CJS, and Types output from the `src` directory
+and place it in the `lib.esm`, `lib`, and `types` directories respectively.
+
+## Overview
+
+```
+lumos-build [args]
+
+Options:
+  --help       Show help                                               [boolean]
+  --version    Show version number                                     [boolean]
+  --esm        Build ESM output                       [boolean] [default: false]
+  --cjs        Build CJS output                       [boolean] [default: false]
+  --types      Build Types output                     [boolean] [default: false]
+  --esmOutDir  Output directory for ESM build      [string] [default: "lib.esm"]
+  --cjsOutDir  Output directory for CJS build          [string] [default: "lib"]
+```
+
+## Contribution
+
+This package only works with Lumos project, and the [`./bin`](./bin) is committed to the repository since the typescript is hard to used as an executable file.

devtools/lumos-build/bin/lumos-build.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_child_process_1 = require("node:child_process");
+const node_util_1 = require("node:util");
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const yargs_1 = __importDefault(require("yargs/yargs"));
+const execAsync = (0, node_util_1.promisify)(node_child_process_1.exec);
+const TYPE_TMP_DIR = "_types_tmp";
+async function buildTypes(dirs) {
+    await execAsync(`tsc --declaration --emitDeclarationOnly --outDir ${TYPE_TMP_DIR}`);
+    await Promise.all(dirs.map((dir) => (0, promises_1.cp)(TYPE_TMP_DIR, dir, { recursive: true })));
+    await (0, promises_1.rm)(TYPE_TMP_DIR, { recursive: true });
+}
+// build ESM output, if a package.esm.json exists, use it as package.json
+async function buildEsm(outDir) {
+    await execAsync(`MODULE=esm babel --root-mode upward src --out-dir ${outDir} --extensions .ts -s`);
+    const packageJson = await (0, promises_1.access)("package.esm.json").then(() => (0, promises_1.readFile)("package.esm.json"), () => JSON.stringify({ type: "module" }));
+    // mark package.json as module
+    await (0, promises_1.writeFile)((0, node_path_1.join)(outDir, "package.json"), packageJson);
+}
+async function main() {
+    const argv = await (0, yargs_1.default)(process.argv.slice(2))
+        .scriptName("lumos-build")
+        .usage("$0 [args]")
+        .option("esm", {
+        type: "boolean",
+        default: false,
+        description: "Build ESM output",
+    })
+        .option("cjs", {
+        type: "boolean",
+        default: false,
+        description: "Build CJS output",
+    })
+        .option("types", {
+        type: "boolean",
+        default: false,
+        description: "Build Types output",
+    })
+        .option("esmOutDir", {
+        type: "string",
+        default: "lib.esm",
+        description: "Output directory for ESM build",
+    })
+        .option("cjsOutDir", {
+        type: "string",
+        default: "lib",
+        description: "Output directory for CJS build",
+    }).argv;
+    //  "build": "run-p build:*",
+    //   "build:types": "tsc --declaration --emitDeclarationOnly",
+    //   "build:js": "MODULE=cjs babel --root-mode upward src --out-dir lib --extensions .ts -s",
+    //   "build:esm": "MODULE=esm babel --root-mode upward src --out-dir lib.esm --extensions .ts -s",
+    // prettier-ignore
+    await Promise.all([
+        argv.esm && buildEsm(argv.esmOutDir),
+        argv.cjs && execAsync(`MODULE=cjs babel --root-mode upward src --out-dir ${argv.cjsOutDir} --extensions .ts -s`),
+        argv.types && buildTypes([
+            argv.esm ? argv.esmOutDir : '',
+            argv.cjs ? argv.cjsOutDir : ''
+        ].filter(Boolean))
+    ].filter(Boolean));
+}
+main();

devtools/lumos-build/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "lumos-build",
+  "private": true,
+  "version": "0.21.0-next.0",
+  "description": "Bigint support in lumos",
+  "author": "",
+  "homepage": "https://github.com/ckb-js/lumos#readme",
+  "license": "MIT",
+  "bin": {
+    "lumos-build": "./bin/lumos-build.js"
+  },
+  "dependencies": {
+    "@types/yargs": "^17.0.24",
+    "yargs": "^17.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ckb-js/lumos.git"
+  },
+  "scripts": {
+    "fmt": "prettier --write \"{src,tests,examples}/**/*.ts\" package.json",
+    "lint": "eslint -c ../../.eslintrc.js \"{src,tests,examples}/**/*.ts\"",
+    "build": "tsc",
+    "clean": "rm -rf lib",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "bugs": {
+    "url": "https://github.com/ckb-js/lumos/issues"
+  },
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}