Add contextual notices in your scripts and text files, based on the #warning directive in C

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-achtung --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-achtung');

Enter text prefixed by |!| in the source of any text file:

// |!| Enter a warning / notice here

This will result in the notice and line number being outputted to the console when the achtung task runs.

This can be useful for drawing attention to incomplete code that needs to be revisited before release.

Read more on the C directive upon which this plugin is based here.

In your project's Gruntfile, add a section named achtung to the data object passed into grunt.initConfig().

grunt.initConfig({
  achtung: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Type: Boolean Default value: false

If set to true the task will fail and exit when a notice is encountered. This is usually for production builds where notices may indicate unfinished functionality.

Type: String Default value: |!|

The string pattern indicating notices. Usually entered within a comment block.

// |!| This notice will be displayed when the "achtung" task runs

In this example javascript source files are searched for notice declarations. Any notices will be outputted to the console with their line number.

grunt.initConfig({
  achtung: {
    src: 'js/*.js',
  },
});

In this example various types of source files are searched for notice declarations.

grunt.initConfig({
  achtung: {
    src: ['js/*.js', 'css/*.css', 'html/*.html'],
  },
});

In this example various targets are declared.

grunt.initConfig({
  achtung: {
    dev {
    	src: ['src/js/*.js', 'src/css/*.css'],
    },
    prod {
    	src: ['dist/js/*.js', 'dist/css/*.css'],
    }
  },
});

In this example, the default options are overridden for all targets.

grunt.initConfig({
	options: {
		strict: true,
		pattern: '#warning'
	},  
	achtung: {
		dev {
			src: 'src/js/*.js',
		},
		prod {
			src: 'dist/js/*.js',
		}
  },
});

In this example the achtung:prod target has its own custom options.

grunt.initConfig({
  achtung: {
    dev {
    	src: 'js/*.js',
    },
    prod {
    	options: {
    		strict: true
    	},
    	src: 'js/*.js',
    }
  },
});

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.

• v0.1.0 – Initial release
• v0.1.3 – Updating publish meta
• v0.1.4 – Updating publish meta