Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aiji42/remix-esbuild-override
This is a library that makes it possible to change the configuration values of the Remix compiler (esbuild).
https://github.com/aiji42/remix-esbuild-override
Last synced: 8 days ago
JSON representation
This is a library that makes it possible to change the configuration values of the Remix compiler (esbuild).
- Host: GitHub
- URL: https://github.com/aiji42/remix-esbuild-override
- Owner: aiji42
- License: mit
- Created: 2022-03-11T14:57:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T11:55:36.000Z (about 1 year ago)
- Last Synced: 2024-10-16T01:23:07.150Z (23 days ago)
- Language: TypeScript
- Homepage:
- Size: 1.67 MB
- Stars: 89
- Watchers: 2
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/remix-esbuild-override)
[](https://codecov.io/gh/aiji42/remix-esbuild-override)
# :minidisc: remix-esbuild-override
:warning: While I believe you will most likely get a lot of benefit from using this library, it can sometimes destroy your product.
Please be sure to verify it and make sure it is safe before releasing it to production.
## What is this?
This is a library that makes it possible to change the configuration values of the [Remix](https://remix.run/) compiler (esbuild).
For example, Next.js allows you to control webpack option values from a configuration file (`next.config.js`).
Remix does not have that functionality. A member of the development team says in a [PR comment](https://github.com/remix-run/remix/pull/2168#issuecomment-1058193715) that this is because exposing the configuration values would lock in the compiler's choices and also risk breaking the application.
I support that argument, but in actual use cases, I often want to change the settings.
So I decided to provide that functionality outside of Remix (in this 3rd-party library).
## Install
```bash
# npm
npm install -D remix-esbuild-override
# yarn
yarn add -D remix-esbuild-override
```
2. Add `remix-esbuild-override` to `scripts.postinstall` in package.json.
```json
"scripts": {
"postinstall": "remix-esbuild-override"
}
```
3. Run `npm install` or `yarn install` again to run `postinstall`
## How to use
You can define function properties in `remix.config.js` that can override esbuild configuration values.
```js
// remix.config.js
const { withEsbuildOverride } = require("remix-esbuild-override");
/**
* Define callbacks for the arguments of withEsbuildOverride.
* @param option - Default configuration values defined by the remix compiler
* @param isServer - True for server compilation, false for browser compilation
* @param isDev - True during development.
* @return {EsbuildOption} - You must return the updated option
*/
withEsbuildOverride((option, { isServer, isDev }) => {
// update the option
option.plugins = [someEsbuildPlugin, ...option.plugins];
return option;
});
/**
* @type {import('@remix-run/dev').AppConfig}
*/
module.exports = {
// ...
};
```
:memo: NOTE: Compilation is executed twice, once for the server and once for the browser.
### Examples
- [emotion on Cloudflare](https://github.com/aiji42/remix-esbuild-override/tree/main/examples/emotion-cloudflare)
- [Chakra UI on Cloudflare](https://github.com/aiji42/remix-esbuild-override/tree/main/examples/chakra-ui-cloudflare)
- [Styled componets](https://github.com/aiji42/remix-esbuild-override/tree/main/examples/styled-components)
If you have other example requests, please create an issue. Additional pull requests for examples are also welcome.
## Contributing
Please read [CONTRIBUTING.md](https://github.com/aiji42/remix-esbuild-override/blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/aiji42/remix-esbuild-override/blob/main/LICENSE) file for details