# webpack-sandbox-external-plugin

**Repository Path**: mirrors_JaneaSystems/webpack-sandbox-external-plugin

## Basic Information

- **Project Name**: webpack-sandbox-external-plugin
- **Description**: Webpack plugin to treat a module as an external that's safe to run in an Electron sandbox.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Webpack Sandbox External Plugin

This webpack plugin treats modules as externals in a way that doesn't cause errors when their required in an Electron sandbox.

It is heavily based on webpack's internal Webpack plugin.

Instead of outputting code like:
```javascript
module.exports = require('keytar');
```

It outputs code like this for externals:
```javascript
if (!process.sandboxed) module.exports = require('keytar');
```

## Install

```sh
yarn add -D webpack-sandbox-external-plugin
```

## Usage

Add the plugin to your `webpack` config. For example:

```javascript
const SandboxExternalPlugin = require('webpack-sandbox-external-plugin');

module.exports = {
  plugins: [
    new SanboxSafeExternalsPlugin(
      'commonjs', // output type
      ['sqlite3', 'keytar'], // modules to externalize
    ),
  ],
};
```

> :warning: Only works for commonjs outputs, currently.