Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aheissenberger/esbuild-plugin-text-replace
Replace content before bundling with support for Filefilter, Namespace, Regex and Functions.
https://github.com/aheissenberger/esbuild-plugin-text-replace
Last synced: about 2 months ago
JSON representation
Replace content before bundling with support for Filefilter, Namespace, Regex and Functions.
- Host: GitHub
- URL: https://github.com/aheissenberger/esbuild-plugin-text-replace
- Owner: aheissenberger
- License: bsd-2-clause
- Created: 2021-05-11T19:07:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-26T11:12:47.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T04:47:45.775Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 605 KB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# esbuild-plugin-text-replace
Replace content before bundling with support for Filefilter, Namespace and Regex.
## Install
$ npm install --save-dev esbuild-plugin-text-replace
**Hint:** Node >=10.1.0 for fs.promise
## Usage
**as a plugin**
```js
import esbuild from 'esbuild'
import textReplace from 'esbuild-plugin-text-replace'
await esbuild.build(
{
entryPoints: ['./test-build-input'],
outfile: 'test-build-out.js',
plugins: [
textReplace(
{
include: /mypackage\/dist\/loader\.js$/,
pattern:[
['const installRetry','let installRetry'],
[/const\s+{\s*textReplace\s*}\s*=\s*require\s*\(\s*'esbuild-plugin-text-replace'\s*\)\s*;/g , "'import textReplace from 'esbuild-plugin-text-replace'"]
]
}
)
],
}
)
```
**as part of a pipe**
```js
import esbuild from 'esbuild';
import pipe from 'esbuild-plugin-pipe';
import textReplace from 'esbuild-plugin-text-replace';
await esbuild.build(
{
entryPoints: ['./test-build-input'],
outfile: 'test-build-out.js',
bundle: true,
plugins: [
pipe({
filter: /.*/,
namespace: '',
plugins: [
textReplace(
{
include: /mypackage\/dist\/loader\.js$/,
pattern:[
['const installRetry','let installRetry'],
[/const\s+{\s*textReplace\s*}\s*=\s*require\s*\(\s*'esbuild-plugin-text-replace'\s*\)\s*;/g , "'import textReplace from 'esbuild-plugin-text-replace'"]
]
}
)
]
})
]
}
)
```
## Options
### `include`
Filter filepath by regex.
Type: `RegExp`
Default: `/.*/`
> **Note:** Try to never use the default value as this is has a huge impact on speed if all files are matched!
### `namespace`
Type: `String`
Default: all
More info about [esbuild namespaces](https://esbuild.github.io/plugins/#namespaces)
### `pattern`
Search with Text or Regex and replace the found content with a string.
Type: `Array`
Default: `[]`
All information about the [replaceAll regex Options and replacer functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll).
**Examples:**
```js
[
// transform 2020-10-02 to 02.10.2020
[/(\d{4})-(\d{2})-(\d{2})/g , (match,p1,p2,p3,offset,wholeString)=>`${p3}.${p2}.${p1}`],
['__buildVersion' , '"1.1.1"'],
[/(\s*)const(\s+a\s*=\s*1[\s;\n])/g, '$1let$2']
]
```
> **Note:** `/g` for globale replacement is a must requirement
## History
* 1.3.0 **pipe mode only:** Use the regex from parameter include to transform only files which match
* 1.2.0 Add [esbuild pipe](https://github.com/nativew/esbuild-plugin-pipe) support
* 1.1.3 Initial relase
## Roadmap
- [X] tests
- [ ] speed tests
## Contribution
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
1. Fork the Project
1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
1. Commit your Changes (git commit -m 'Add some AmazingFeature')
1. Push to the Branch (git push origin feature/AmazingFeature)
1. Open a Pull Request
## Built With
- [microbundle](https://github.com/developit/microbundle)
## License
Distributed under the "bsd-2-clause" License. See [LICENSE.txt](LICENSE.txt) for more information.