Skip to content

Commit

Permalink
Merge pull request #36 from netlify/deprecation
Browse files Browse the repository at this point in the history
Deprecate this Fork
  • Loading branch information
Skn0tt committed Sep 6, 2023
2 parents 21a4965 + 01668ad commit 4fb07f3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
7 changes: 4 additions & 3 deletions NETLIFY.md
@@ -1,14 +1,15 @@
# @netlify/esbuild

This is a fork of esbuild maintained by Netlify. If you're interested in using or contributing to this fork, please read this document carefully.
This fork of esbuild was maintained by Netlify. esbuild added support for [glob-style imports](https://esbuild.github.io/api/#glob),
which should be used instead of the `onDynamicImport` hook provided by this fork.

## Objectives and guiding principles

We're big fans of esbuild at Netlify! ❤️

[zip-it-and-ship-it](https://github.com/netlify/zip-it-and-ship-it), our serverless functions bundler, uses esbuild to prepare JavaScript and TypeScript functions for deployment. In that context, there are certain features that we require in order to provide a smooth experience for our customers, some of which aren't provided by esbuild out-of-the-box just yet.

We've implemented those changes in this fork, which we maintain with the following principles:
We've implemented those changes in this fork, which we maintained with the following principles:

1. **Minimize changes**: We don't have a different vision for esbuild, so we'll keep our changes to the mininum necessary. We won't introduce breaking changes to existing APIs.

Expand All @@ -18,7 +19,7 @@ We've implemented those changes in this fork, which we maintain with the followi

4. **Aim for unification**: We plan every feature so that it benefits the esbuild community and not our specific needs (which is made possible by the fact that esbuild is extendable via a plugin API). We do this because our end goal is to eventually decommission this fork and go back to using the main package.

As such, we prioritize the API designs from upstream over ours, which means that features in the fork are more volatile and subject to change based on what happens upstream.
As such, we prioritized the API designs from upstream over ours, which means that features in the fork are more volatile and subject to change based on what happens upstream.

## Changes

Expand Down
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -9,7 +9,9 @@
<a href="https://esbuild.github.io/faq/">FAQ</a>
</p>

> This is a fork of esbuild maintained by Netlify. See [here](NETLIFY.md) for more details.
> esbuild implemented analysis of glob-style imports: https://esbuild.github.io/api/#glob
> We recommend migrating to that, as this fork of esbuild is not maintained anymore.
> See [here](NETLIFY.md) for more details.
## Why?

Expand Down

0 comments on commit 4fb07f3

Please sign in to comment.