https://github.com/kamilkisiela/bob

Build tool used in libraries maintained by The Guild
https://github.com/kamilkisiela/bob

bundler cli typescript yarn-workspaces

Last synced: about 2 months ago
JSON representation

Build tool used in libraries maintained by The Guild

• Host: GitHub
• URL: https://github.com/kamilkisiela/bob
• Owner: kamilkisiela
• Created: 2019-11-14T16:44:04.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T01:01:29.000Z (5 months ago)
• Last Synced: 2024-05-01T12:16:37.242Z (5 months ago)
• Topics: bundler, cli, typescript, yarn-workspaces
• Language: TypeScript
• Homepage:
• Size: 1.08 MB
• Stars: 47
• Watchers: 8
• Forks: 12
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Bob (The ~~Bundler~~ Butler)

Bob is the TypeScript build, bundle and verification tool used by almost all

[The Guild](https://the-guild.dev) open source projects.

Scope:

- **Build**: Build ESM and CommonJS compatible npm packages

- **Verify**: Ensure all ESM and CommonJS imports within a npm package are usable

- **Bundle**: Build a single executable for an application (experimental)

## Requirements

- Yarn workspace or single package project

- TypeScript

- It's so strict you shouldn't use it!

## Setup

Setting up bob is currently undocumented. You can check

[GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator) repository (or any

other The Guild repository).

## Configuration

You can add a `bob` key to each `package.json`.

**Disable bob for a single package**

```jsonc

{

  "name": "graphql-lfg",

  "bob": false // exclude a single package from all things bob related

}

```

**Disable build for a single package**

```json

{

  "name": "graphql-lfg",

  "bob": {

    "build": false

  }

}

```

**Disable check for a single package**

```json

{

  "name": "graphql-lfg",

  "bob": {

    "check": false

  }

}

```

**Disable check for a single export in a package**

```json

{

  "name": "graphql-lfg",

  "bob": {

    "check": {

      "skip": ["./foo"]

    }

  }

}

```

## Usage

```bash

$ bob build

$ bob check

```