alloc / alloc/saus

[RFC] Option-driven tree-shaking toggles

Open
#74 0 comments 0 reactions 0 assignees View on GitHub
proposal roadmap
Dominant language
TypeScript
Stars
38
Forks
1
PR merge metrics
No merged PRs in 30d

Description

## The Problem

There's no simple way to include code in client/server bundle only when a specific plugin/framework option has a specific value at build time.

### Example

In any Vite-compiled module:

```ts
// @toggle foo
callSomeFunction(...args)
```

The `foo` toggle should be registered with Saus **at build time:**

```ts
export function MySausPlugin(options) {
return {
name: 'my-saus-plugin',
saus({ toggles }) {
// The `foo` option of my plugin decides if "foo" toggle is removed.
if (options.foo) {
toggles.use("foo")
}
}
}
}
```

In the above example, if the `foo` option of `MySausPlugin` is falsy, the `callSomeFunction` line is removed at build time.

Ideally, plugins would use namespaces in their toggle IDs:

```ts
// @toggle my-saus-plugin.foo
callSomeFunction(...args)
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.