Toggle comments inside build blocks.
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-comment-toggler --save-dev
The "toggleComments" task
toggleComments searches files for build blocks and comments
or uncomments individual lines or a whole block depending on the command and
delimiter specified in the build block.
Build blocks are defined using the following syntax:
<!-- comments:(command) (comment delimiter) --> Your code goes here <!-- endcomments -->
commandis the type of processing done for each line. Following commands are supported:
togglefor using line comments.
toggle-blockfor block comments. Block commenting only supports special delimiters.
comment delimiteris the delimiter used for comments. Any sequence of non-whitespace characters is valid. There are two special delimiters that can be used.
CSS specifying a single delimiter for comments isn't enough.
For this purpose there are two special delimiters
css that use
appropriate block comments to process each line or the whole block. See
examples on how to use them.
Amount of whitespace between the comment delimiters and the line content.
true, removes the
<!-- comments:... --> and
<!-- endcomments -->
definitions from the file during processing. Can be used to prevent conflicts
with other Grunt plugins that use similar build block syntax.
Basic uncommenting example
Example using a single character to uncomment line
# <!-- comments:uncomment # --># AddHandler application/x-httpd-php54 .php# <!-- endcomments -->
HTML & CSS line and block examples
How to process HTML and CSS block comments using special delimiters
Custom options example
This example shows the usage of custom options as well as a sample output.
toggleComments:customOptions:options:padding: 4removeCommands: truefiles: "targetfile.js": "testfile.js"
// <!-- comments:comment // -->var txt = "This will be commented with the padding";// var txt2 = "This line will not have padding, since it's already commented";// <!-- endcomments -->var txt3 = "This is not affected";
Outputs the following in targetfile.js
// var txt = "This will be commented with the padding";// var txt2 = "This line will not have padding, since it's already commented";var txt3 = "This is not affected";
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.
0.2.0 - 2014-07-17
- Added support for block comments
0.1.0 - 2014-06-06
- Initial release