grunt-directory-security

0.2.0 • Public • Published

grunt-directory-security v0.2.1

Copy an empty index.html into all the existing folders except the root. This prevents directory browsing.

Getting Started

This plugin requires Grunt ~0.4.0

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-directory-security --save-dev

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

grunt.loadNpmTasks('grunt-directory-security');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Copy task

Run this task with the grunt preventFolderBrowsing command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

root

Type: String
Default: dist

Location that needs to be protected against folder browsing.

includeSubFolders

Type: Boolean
Default: true

Wheter to copy the blankHtmlPage the subfolders of the root. When this is set to 'true' the blankHtmlPage will NOT be copied to the root folder. When this is set to 'false' the blankHtmlPage will ONLY be copied into the root folder.

blankHtmlFile

Type: String
Default: index.html

The file that is copied to the subfolders to prevent folder browsing. This file can be customized to fit the need of the users.

Usage Examples

preventFolderBrowsing: {
    all: {
        options: [{
            root: 'dist/',
            includeSubFolders: true,
            blankHtmlPage: 'index.html'
        }]	
    }			
},

Package Sidebar

Install

npm i grunt-directory-security

Weekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

4.72 kB

Total Files

4

Last publish

Collaborators

  • bmeermans