Bundle with tsup #670
Bundle with tsup #670
Conversation
| "unpkg": "dist/sql-formatter.min.js", | ||
| "module": "lib/index.js", | ||
| "types": "lib/src/index.d.ts", |
There was a problem hiding this comment.
Removing the types field both here and in exports lets TypeScript resolve the correct types by filename.
| @@ -3,16 +3,14 @@ | |||
| "version": "14.0.0", | |||
| "description": "Format whitespace in a SQL query to make it more readable", | |||
| "license": "MIT", | |||
| "main": "dist/sql-formatter.min.cjs", | |||
| "main": "dist/index.cjs", | |||
There was a problem hiding this comment.
This now uses the un-minified, non-UMD bundle. I think this is ok; unpkg will continue using the minified+UMD bundle produced by webpack.
| // Intentionally use "export *" syntax here to make sure when adding a new SQL dialect | ||
| // we wouldn't forget to expose it in our public API. | ||
| export * from './allDialects.js'; | ||
| // When adding a new dialect, be sure to add it to the list of exports below. |
There was a problem hiding this comment.
Removing the export * was necessary because esbuild transformed it into code that wasn't statically analyzable for tree shaking. If desired, I can look into adding a test that asserts that this file has all the necessary language imports?
|
@nene it looks like the latest version of |
|
No other reason of using Node 14 besides me not having bothered to witch the CI to a newer version. |
This PR aims to resolve #604. It uses
tsupto bundle code and emit both CJS and ESM (and dedicated types for each). While I don't love bundling code,tsupmakes it really straightforward to get something that "just works".An alternative we could use
tscdirectly to emit ESM/CJS builds todist/esmanddist/cjs, respectively, then make a second pass with a custom script to renamedist/cjs/*.jstodist/cjs/*.cjs. Unfortunatelytsccan't do this natively: microsoft/TypeScript#49462