https://github.com/runmaxde/vite-plugin-singlefile-escaped
Escape the output of vite-plugin-singlefile and optionally wrap it with custom strings
https://github.com/runmaxde/vite-plugin-singlefile-escaped
react vite vite-plugin vitejs
Last synced: 4 months ago
JSON representation
Escape the output of vite-plugin-singlefile and optionally wrap it with custom strings
- Host: GitHub
- URL: https://github.com/runmaxde/vite-plugin-singlefile-escaped
- Owner: runmaxde
- Created: 2024-02-13T08:33:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T07:19:21.000Z (over 2 years ago)
- Last Synced: 2025-11-28T09:16:23.795Z (7 months ago)
- Topics: react, vite, vite-plugin, vitejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/vite-plugin-singlefile-escaped
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# vite-plugin-singlefile-escaped
This Vite plugin allows you to escape the output of `vite-plugin-singlefile` and optionally wrap it with custom strings before and after. It uses `jsesc` to escape the content, making it safe for embedding in specific environments or as part of a larger string.
## Installation
```bash
npm install vite-plugin-singlefile-escaped --save-dev
```
or if you prefer using Yarn:
```bash
yarn add vite-plugin-singlefile-escaped --dev
```
## Usage
To use `vite-plugin-singlefile-escaped` in your Vite project, import it into your `vite.config.js` or `vite.config.ts` and add it to the `plugins` array. You also need to have `vite-plugin-singlefile` installed and configured, as this plugin works on its output.
```js
// vite.config.js
import { viteSingleFile } from "vite-plugin-singlefile";
import viteSingleFileEscaped from "vite-plugin-singlefile-escaped";
export default {
plugins: [
viteSingleFile(),
viteSingleFileEscaped()
],
};
```
## Configuration
`viteSingleFileEscaped` accepts two optional parameters to customize the wrapping of the escaped content and an optional posibility of a configuration for more precise escaping
```js
function viteSingleFileEscaped(wrapBefore: string, wrapAfter: string, config: object): void
```
- wrapBefore: A string to prepend before the escaped content.
- wrapAfter: A string to append after the escaped content.
- config: A destructured object that allows to add special configurations [Jsesc Docs](https://www.npmjs.com/package/jsesc)
If not provided, these parameters default to an empty string, meaning no wrapping will be applied beyond escaping the content.
Example
Here is an example configuration that escapes the entire output of your single-file bundle and wraps it in a JavaScript log function:
```js
// vite.config.js
import { viteSingleFile } from "vite-plugin-singlefile";
import viteSingleFileEscaped from "vite-plugin-singlefile-escaped";
export default {
plugins: [
viteSingleFile(),
viteSingleFileEscaped('console.log("', ");", { quotes: "double" }),
],
};
```
```js
// dist/index.html
console.log("");
```
This setup escapes the single-file output and wraps it with `console.log("` at the beginning and `");` at the end, making it ready to be logged directly to the console as part of a larger script or debugging tool.
## License
This plugin is open-sourced software licensed under the MIT license.
