Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PabloSzx/bob-esbuild
Building and Running TypeScript projects efficiently with rollup + esbuild
https://github.com/PabloSzx/bob-esbuild
esbuild typescript
Last synced: 2 months ago
JSON representation
Building and Running TypeScript projects efficiently with rollup + esbuild
- Host: GitHub
- URL: https://github.com/PabloSzx/bob-esbuild
- Owner: PabloSzx
- Created: 2021-05-27T07:18:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T16:35:56.000Z (8 months ago)
- Last Synced: 2024-04-23T21:59:46.713Z (8 months ago)
- Topics: esbuild, typescript
- Language: TypeScript
- Homepage:
- Size: 1.44 MB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bob-esbuild
## bob-tsm
[](https://npm.im/bob-tsm)
Check the package [bob-tsm](/packages/bob-tsm/README.md) inspired on https://github.com/lukeed/tsm with extra support for watch mode and with extra fixes to follow the new [TypeScript 4.5 extensions](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta/#new-file-extensions) `.mts`=>`ESM` and `.cts`=>`CommonJS`.
## bob-ts
[](https://npm.im/bob-ts)
Check the new library [bob-ts](/packages/bob-ts/README.md) made to accelerate and simplify the TypeScript development with watcher and first class support for JavaScript testing frameworks.
## Blog Post
Check my latest blog post [What does it take to support Node.js ESM?](https://the-guild.dev/blog/support-nodejs-esm)
## Notes
Is recommended to be used with [pnpm](https://pnpm.io/), but it's not a requirement and it should to work with any package manager.
This library is primarily focused into monorepo projects, and all the instructions are going to be focused on that usage.
## Install
If you are using it in a monorepo project, you have to install it in your root like this:
```sh
pnpm add bob-esbuild bob-esbuild-cli
pnpm add -D esbuild
```
Then, in every package you want to build with `bob-esbuild`, you can simply install `bob-esbuild-cli`:
```sh
pnpm add bob-esbuild-cli
```
## Usage
In your root, you have to make a file called `bob-esbuild.config.ts`, and it's body should be like this:
```ts
export const config: import('bob-esbuild').BobConfig = {
tsc: {
dirs: ['packages/*'],
},
verbose: true,
};
```
You can use all the typescript auto-completion and type-safety to inspect all the possible options.
But a required configuration is to specify the `tsc.dirs` with the pattern of directories you want to add the types to.
In every package you want to build, you have to specify in every package.json:
```json
{
"prepack": "bob-esbuild build"
}
```
Or, if you want to build it alongside in the monorepo setup:
```json
{
"prepare": "bob-esbuild build"
}
```
Then in your root monorepo a recommended build script would be something like this:
```json
{
"scripts": {
"build": "bob-esbuild tsc && pnpm prepack -r"
}
}
```
And it will pre-build the types, and call the "prepack" script in every package in your monorepo.
## ESM Support
Check my latest blog post [What does it take to support Node.js ESM?](https://the-guild.dev/blog/support-nodejs-esm)
This library is focused on giving first-class support for Node.js ESM, and for that reason, it always builds a `.js` file for CommonJS, alongside a `.mjs` file for ESM.
In every package you build for, you have to specify the package.json fields like this:
> You can also change the "dist" folder to any name, you only have to be consistent and change it in your root configuration in the field "distDir"
> This also enables to import every module separately
```json
{
"main": "dist/index.js",
"module": "dist/index.mjs",
"types": "dist/index.d.ts",
"exports": {
".": {
"require": "./dist/index.js",
"import": "./dist/index.mjs"
},
"./*": {
"require": "./dist/*.js",
"import": "./dist/*.mjs"
}
}
}
```
## tsconfig
`bob-esbuild` enforces specifying a couple of options in your root tsconfig, and it will error out if you are not doing it:
```json
{
"compilerOptions": {
"outDir": "",
"rootDir": "."
}
}
```
And it's recommended to use `tsconfig` paths & baseUrl, check [the official docs](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping) about it.