Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betaorbust/babel-plugin-groundskeeper-willie
The spiritual successor to groundskeeper. Removes console calls, debuggers, and and pragma-wrapped code.
https://github.com/betaorbust/babel-plugin-groundskeeper-willie
Last synced: 3 months ago
JSON representation
The spiritual successor to groundskeeper. Removes console calls, debuggers, and and pragma-wrapped code.
- Host: GitHub
- URL: https://github.com/betaorbust/babel-plugin-groundskeeper-willie
- Owner: betaorbust
- Created: 2016-07-22T21:10:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T17:26:59.000Z (almost 2 years ago)
- Last Synced: 2024-06-18T20:06:32.375Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 511 KB
- Stars: 64
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-babel - groundskeeper-willie - Removes debugger and console calls. (Plugins / Optimization)
README
# Groundskeeper Willie Babel Plugin
[](https://badge.fury.io/js/babel-plugin-groundskeeper-willie)
This project is a Babel plugin encompassing and expanding the functionality of the very useful [Groundskeeper](https://github.com/Couto/groundskeeper) utility. Remaking Groundskeeper's
features as a Babel plugin gives ongoing support to ES2015+, while greatly reducing runtime
for those already using Babel in their build process.
This plugin will:
- **Remove `console` statements, so your production code doesn't junk up the console,
but your development code can be as verbose as you wish.**
- To keep specific console statements, you can disable Groundskeeper Willie by adding
a line disable directive, which makes it significantly more flexible compared to [babel-plugin-transform-remove-console](https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-remove-console)
Source:
```javascript
console.log(`I'll be removed.`);
console.log(`I'll be preserved!`); // groundskeeper-willie-disable-line
```
Result:
```javascript
console.log(`I'll be preserved!`); // groundskeeper-willie-disable-line
```
- **Remove `debugger` statements, so you don't accidentally ship halting code.**
- Same as above, you can disable this in specific cases with a line disable directive.
Source:
```javascript
() => {
debugger;
do.something();
debugger; // groundskeeper-willie-disable-line
}
```
Result:
```javascript
() => {
do.something();
debugger; // groundskeeper-willie-disable-line
}
```
- **Remove code between comment ``, so you can use your debug code in development, but strip it out in production.**
Source:
```javascript
module.exports = {
prodFunction() {
/* ... */
},
//
testFunction() {
/* ... */
},
//
otherProdCode() {
/* ... */
},
};
```
Result:
```javascript
module.exports = {
prodFunction() {
/* ... */
},
otherProdCode() {
/* ... */
},
};
```
## Complete Example:
#### Input:
Here we have a file that has some development code, a console, etc.
```javascript
module.exports = {
appCode(){
console.log(`We're running with scissors!`);
return [
'included',
/**/
'excluded',
/**/
'also included'];
}
};
//
module.exports.debugCode = {
do.debugging.things.that.should.not.be.in.production();
}
//
```
#### Output:
When run with the Groundskeeper Willie plugin, we'll get back:
```javascript
module.exports = {
appCode() {
return ['included', 'also included'];
},
};
```
## Why would you do that?
Right now, we (at Netflix) use pragmas so that our developer logging, debug code, and
other related exports can live alongside the production code, but, at distribution time,
we can ship down the smallest payload, without junking up the console, or sending extra
unused code.
## What's a pragma?
For the purposes of our little plugin, pragmas are comments that have an opening
tag, and a closing tag, with a provided name. The pragma may appear in either a line
comment or a block comment, and look like HTML/XML-esq open and close tags.
```javascript
//
const removed = code.that.will.be.removed();
//
return ['included', /* */ 'excluded', /* */ 'also included'];
```
## Plugin Options
The following are the available options with their default values.
```json
{
"plugins": [
[
"groundskeeper-willie",
{
"removeConsole": true,
"removeDebugger": true,
"removePragma": true
}
]
]
}
```
#### `removeConsole`
If you wish to leave in all console statements, set this to false.
#### `removeDebugger`
If you wish to leave in all debugger statements, set this to false.
#### `removePragma`
If you wish to leave in all pragmas-wrapped code, stet this to false.