Skip to content

Latest commit

 

History

History
149 lines (121 loc) · 4.21 KB

README.md

File metadata and controls

149 lines (121 loc) · 4.21 KB
Raw

grunt-comment-toggler

Toggle comments inside build blocks.

Getting Started

This plugin requires Grunt ~0.4.5

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

Build blocks are defined using the following syntax:

<!-- comments:(command) (comment delimiter) -->
Your code goes here
<!-- endcomments -->

  • command is the type of processing done for each line. Following commands are supported:

    • comment, uncomment and toggle for using line comments.
    • comment-block, uncomment-block and toggle-block for block comments. Block commenting only supports special delimiters.

  • comment delimiter is the delimiter used for comments. Any sequence of non-whitespace characters is valid. There are two special delimiters that can be used.

Special delimiters

For HTML and CSS specifying a single delimiter for comments isn't enough. For this purpose there are two special delimiters html and css that use appropriate block comments to process each line or the whole block. See examples on how to use them.

Options

padding

Type: Number
Default: 1

Amount of whitespace between the comment delimiters and the line content.

removeCommands

Type: Boolean
Default: false

When 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.

Examples

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

<style>
    /* <!-- comments:toggle css --> */
    p {color: red}
    /* p {color: blue} */
    /* <!-- endcomments --> */
    
    /* The code above will swap the color from red to blue */
</style>

<!-- comments:comment html -->
<p>This line will be commented</p>
<!-- endcomments -->

<!-- comments:uncomment-block html -->
<!--
<p>
  This whole block will be uncommented.
  Useful for production only JavaScript
  and CSS, where commenting each line
  individually would be inconvenient.
</p>
-->
<!-- endcomments -->

Custom options example

This example shows the usage of custom options as well as a sample output.

Gruntfile.js

toggleComments: {
    customOptions: {
        options: {
            padding: 4,
            removeCommands: true
        },
        files: {"targetfile.js": "testfile.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";

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.

Changelog

0.2.2 - 2016-02-22

  • Support Grunt 1.0

0.2.1 - 2015-04-23

  • Fix "Warning: Cannot assign to read only property 'regex' of search" (#2)

0.2.0 - 2014-07-17

  • Added support for block comments

0.1.0 - 2014-06-06

  • Initial release