entropyxyz / sdk

Official JavaScript SDK for Entropy blockchain.

GNU Affero General Public License v3.0

7 stars 0 forks source link

investigate typescript transpiling #376

Open mixmix opened 3 weeks ago

mixmix commented 3 weeks ago

CLI needs this SDK has tsup mess?

mixmix commented 3 weeks ago

Typescript transpiling

Requirements

support CJS + MJS
don't bundle all the deps?
- e.g. don't make 1 mega-file, deps should be required/imported as usual
- may mean we need to consider versions ranges
- LOCK POLKADOT VERSION EXACTLY
export external facing types
- @types directory
- @types/keys ??
comments in the tsconfig
should we change the typescript version?
- WARN: current website docs are for latest version ONLY

Plan

Pre-work
- micro-PR (Mix)
- for hand-written entry point files (cjs, mjs)
- remove "type: module"?
- remove the unused entry points
- prune types (Frankie)
- only export types we want externally used
- security sensitive areas
Open some Draft PRs to explore different build systems
- mix - rollup, swc
- frankie - raw tsc: for types

package.json scripts

yarn build:cjs
yarn build:mjs
yarn build:types
yarn build #should run cjs & mjs & types

mixmix commented 3 weeks ago

micro-PR: https://github.com/entropyxyz/sdk/pull/379