# Speedy
Incredibly fast ECMAScript & TypeScript toolchain optimized for development.
## Motivation
Nobody should have to wait for build tools to be productive.
## Purpose
The purpose of Speedy is to very quickly convert ECMAScript/TypeScript into something a web browser can execute.
Goals:
- Transpile fast. "Fast" is defined as "<= 3ms per un-minified file up to 1000 LOC" without a build cache
- Transpile JSX to ECMAScript
- Remove TypeScript annotations
- Conditionally support React Fast Refresh
- Rewrite CommonJS/SystemJS/UMD imports and exports to ESM
- Support most of tsconfig.json/jsconfig.json
- Support `defines` like in esbuild
- Support esbuild plugins
- Support importing CSS files from JavaScript
- Tree-shaking
Non-goals:
- Bundling for production
- Minification
- AST plugins
- Support Node.js
- CommonJS, UMD, IIFE
- ES6 to ES5
- Supporting non-recent versions of Chromium, Firefox, or Safari. (No IE)
## How it works
Much of the code is a line-for-line port of esbuild to Zig. Thank you @evanw for building esbuild - a fantastic ECMAScript & CSS Bundler, and for inspiring this project.
### Compatibility Table
| Feature | Speedy |
| ------------------------------------ | ------ |
| JSX (transform) | ✅ |
| TypeScript (transform) | ⌛ |
| React Fast Refresh | ⌛ |
| Hot Module Reloading | ⌛ |
| Minification | ❌ |
| Tree Shaking | ⌛ |
| Incremental builds | ⌛ |
| CSS | 🗓️ |
| Expose CSS dependencies per file | 🗓️ |
| CommonJS, IIFE, UMD outputs | ❌ |
| Node.js build target | ❌ |
| Code Splitting | ⌛ |
| Browser build target | ⌛ |
| Bundling for production | ❌ |
| Support older browsers | ❌ |
| Plugins | 🗓️ |
| AST Plugins | ❌ |
| Filesystem Cache API (for plugins) | 🗓️ |
| Transform to ESM with `bundle` false | ⌛ |
Key:
| Tag | Meaning |
| --- | ------------------------------------------ |
| ✅ | Compatible |
| ❌ | Not supported, and no plans to change that |
| ⌛ | In-progress |
| 🗓️ | Planned but work has not started |
| ❓ | Unknown |
### Compatibility Table (more info)
| Feature | Speedy |
| -------------------------------- | ------ |
| `browser` in `package.json` | ⌛ |
| main fields in `package.json` | ⌛ |
| `exports` map in `package.json` | 🗓️ |
| `side_effects` in `package.json` | 🗓️ |
| `extends` in `tsconfig.json` | 🗓️ |
#### Notes
##### Hot Module Reloading & React Fast Refresh
Speedy exposes a runtime API to support Hot Module Reloading and React Fast Refresh. React Fast Refresh depends on Hot Module Reloading to work, but you can turn either of them off. Speedy itself doesn't serve bundled files, it's up to the development server to provide that.
##### Code Splitting
Speedy supports code splitting the way browsers do natively: through ES Modules. This works great for local development files. It doesn't work great for node_modules or for production due to the sheer number of network requests. There are plans to make this better, stay tuned.
##### Support older browsers
To simplify the parser, Speedy doesn't support lowering features to non-current browsers. This means if you run a development build with Speedy with, for example, optional chaining, it won't work in Internet Explorer 11. If you want to support older browsers, use a different tool.
#### Implementation Notes
##### Deviations from other bundlers
Unused imports are removed by default, unless they're an import without an identifier. This is similar to what the TypeScript compiler does, but TypeScript only does it for TypeScript. This is on by default, but you can turn it off.
For example in this code snippet, `forEach` in unused:
```ts
import { forEach, map } from "lodash-es";
const foo = map(["bar", "baz"], (item) => {});
```
So it's never included.
```ts
import { map } from "lodash-es";
const foo = map(["bar", "baz"], (item) => {});
```
If
##### HMR & Fast Refresh implementation
This section only applies when Hot Module Reloading is enabled. When it's off, none of this part runs. React Fast Refresh depends on Hot Module Reloading.
###### What is hot module reloading?
HMR: "hot module reloading"
A lot of developers know what it does -- but what actually is it and how does it work? Essentially, it means when a source file changes, automatically reload the code without reloading the web page.
A big caveat here is JavaScript VMs don't expose an API to "unload" parts of the JavaScript context. In all HMR implementations, What really happens is this:
1. Load a new copy of the code that changed
2. Update references to the old code to point to the new code
3. Handle errors
The old code still lives there, in your browser's JavaScript VM until the page is refreshed. If any past references are kept (side effects!), undefined behavior happens. That's why, historically (by web standards), HMR has a reputation for being buggy.
Loading code is easy. The hard parts are updating references and handling errors.
There are two ways to update references:
- Update all module imports
- Update the exports
Either approach works.
###### How it's implemented in Speedy
TODO: doc
' height='13' alt='Gravatar' /> Alex Zhang
| 1 | -47/+118 |
| 2024-02-23 | Adds names |  Anshul Gupta
| 1 | -2/+7 |
| 2024-02-23 | Completes Hypothesis 3 | Anshul Gupta
| 1 | -30/+98 |
| 2024-02-23 | Adds many stacked bars | Anshul Gupta
| 1 | -38/+187 |
| 2024-02-23 | Finishes hypothesis 2 | Anshul Gupta
| 1 | -21/+53 |
| 2024-02-23 | Adds some analysis for visualizations | Anshul Gupta
| 1 | -80/+140 |
| 2024-02-23 | Changes chi-squared code |  Anaqvi2020
| 1 | -39/+33 |
| 2024-02-23 | Minor fixes to remove trailing and starting spaces from index names |  ENathanLe
| 2 | -98/+92 |
| 2024-02-23 | Revert "Merge branch 'main' into nlee097_csv_indexing_fixes" | Anshul Gupta
| 2 | -70/+212 |
| 2024-02-22 | Minor fixes to remove trailing and starting spaces from index names | ENathanLe
| 2 | -53/+53 |
| 2024-02-22 | Adds histogram |  Alex Zhang
| 1 | -35/+75 |
| 2024-02-22 | Formatting | Anshul Gupta
| 1 | -1190/+149 |
| 2024-02-22 | Chi-square equation | Anaqvi2020
| 1 | -57/+1255 |
| 2024-02-22 | Fixes annoying `.gitignore` | Anshul Gupta
| 1 | -1/+2 |
| 2024-02-22 | Cleans housing data | Anshul Gupta
| 1 | -20/+28 |
| 2024-02-22 | Resets execution & timestamps | Anshul Gupta
| 1 | -28/+28 |
| 2024-02-22 | Add bar graph and heatmap | ENathanLe
| 1 | -50/+81 |
| 2024-02-22 | More Formattings | Anshul Gupta
| 1 | -26/+114 |
| 2024-02-22 | Adds some formatting | Anshul Gupta
| 1 | -109/+75 |
| 2024-02-22 | Executes cell | Anshul Gupta
| 1 | -22/+60 |
| 2024-02-22 | Pie Chart | Anaqvi2020
| 1 | -24/+36 |
| 2024-02-16 | Fixes typo | Anshul Gupta
| 1 | -11/+11 |
| 2024-02-15 | Fixes `Do you work in a department ...` | Anshul Gupta
| 1 | -12/+39 |
| 2024-02-15 | Fixes 'Who do you live with?' | Anshul Gupta
| 1 | -879/+26 |
| 2024-02-15 | Set nonworkers to 0 hours | Anaqvi2020
| 1 | -35/+890 |
| 2024-02-15 | Adds working and non-working dataframe | Anshul Gupta
| 1 | -10/+51 |
| 2024-02-15 | Adds some preprocessing | Anshul Gupta
| 1 | -9/+34 |
Anshul Gupta
Anaqvi2020
ENathanLe
Alex Zhang