Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jsoverson/grunt-strip

Strip JavaScript nodes (like console.*) out of your source code
https://github.com/jsoverson/grunt-strip

Last synced: 4 days ago
JSON representation

Strip JavaScript nodes (like console.*) out of your source code

Host: GitHub
URL: https://github.com/jsoverson/grunt-strip
Owner: jsoverson
License: mit
Created: 2012-09-24T06:00:35.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2013-03-25T21:36:02.000Z (over 11 years ago)
Last Synced: 2024-11-02T00:03:25.394Z (9 days ago)
Language: JavaScript
Size: 142 KB
Stars: 42
Watchers: 4
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE-MIT

Awesome Lists containing this project

README

# grunt-strip

Strip JavaScript nodes (like console.*) out of your source code

## Getting Started
Install this grunt plugin next to your project's [Gruntfile][getting_started] with: `npm install grunt-strip`

Then add this line to your project's Gruntfile:

```javascript
grunt.loadNpmTasks('grunt-strip');
```

[grunt]: https://github.com/cowboy/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md

## Configuration

### Basic configuration

The most basic configuration will strip out all calls to 'console.*'

```
strip : {
main : {
src : 'src/main.js',
dest : 'src/main.built.js'
}
}
```

### Configuring the nodes to strip out

```
strip : {
main : {
src : 'src/main.js',
dest : 'src/main.built.js',
options : {
nodes : ['console.log', 'debug']
}
}
}
```

*Note:* grunt-strip does not currently support node specificity beyond one property level (i.e. trying to strip 'foo.bar.baz' will not work as expected).

### Bulk inline rewrites

You can specify a list of files to edit inline by omitting the `dest` configuration.

***Warning*** : This **is** a destructive configuration, and you must specify the option `inline:true`
in order for this command to succeed, otherwise it will fail with a warning message.

This is useful in build steps where your entire source tree is copied over (like with the requirejs r.js optimizer).

```
strip : {
main : {
src : 'build/**/*.js',
options : {
inline : true
}
}
}
```

## How it's done

Right now, the logic consists of a simple replacement of your selected nodes with a falsy statement (0).
This is proving to work in all reasonable situations and alleviates the need for complex rewrite logic.

At some later date that rewrite logic may be important, but the cost vs reward isn't there right now.

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt][grunt].

## Release History

- 0.2.1 Added ability to filter on property values
- 0.2.0 Updated for grunt 0.4.0 final
- 0.2.0rc7 Updated for grunt 0.4.0rc7
- 0.1.3 Fixed issues on node 0.6
- 0.1.0 Initial release. Pulled from the [rcl](http://rcljs.com/) project