fix: compile typescript with isolatedModules to remove types from runtime code - Githubissues

atlassian-labs / react-resource-router

Configuration driven routing solution for React SPAs that manages route matching, data fetching and progressive rendering

https://atlassian-labs.github.io/react-resource-router

Apache License 2.0

198 stars 28 forks source link

fix: compile typescript with isolatedModules to remove types from runtime code #147

Closed theKashey closed 2 years ago

theKashey commented 2 years ago

Solves

A Warning for webpack:

WARNING in ./node_modules/react-resource-router/build/esm/controllers/index.js 7:0-55
"export 'WithRouter' was not found in './with-router'
@ ./node_modules/react-resource-router/build/esm/index.js

A Error for esbuld

✘ [ERROR] No matching export in "../../../node_modules/react-resource-router/build/esm/controllers/with-router/index.js" for import "WithRouter"

The fix

activating isolatedModules to force TypeScript to remove typed from produced js, keeping only in d.ts. That removes the problem. During the build TS will complain if type export (not import) has not been properly attributed.

Question

There are other types exported in plain esm right now. Only WithRouter creates a problem

Followup

https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/consistent-type-imports.md (requires typescript-eslint update) can automatically maintain proper usage of import/export type in the code base.