https://github.com/stevenbenner/grunt-indent
:bookmark_tabs: A Grunt task to change the indentation of files.
https://github.com/stevenbenner/grunt-indent
grunt grunt-plugins grunt-task indentation javascript nodejs
Last synced: about 1 year ago
JSON representation
:bookmark_tabs: A Grunt task to change the indentation of files.
- Host: GitHub
- URL: https://github.com/stevenbenner/grunt-indent
- Owner: stevenbenner
- License: mit
- Created: 2013-03-16T15:40:59.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2017-04-23T00:16:10.000Z (about 9 years ago)
- Last Synced: 2025-03-11T14:46:42.646Z (over 1 year ago)
- Topics: grunt, grunt-plugins, grunt-task, indentation, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# grunt-indent
A grunt task to change the indentation of files.
[](https://travis-ci.org/stevenbenner/grunt-indent) [](https://gemnasium.com/stevenbenner/grunt-indent) [](https://www.npmjs.com/package/grunt-indent)
## Getting Started
This plugin requires Grunt `>=0.4.0`
If you haven't used [Grunt](https://gruntjs.com/) before, be sure to check out the [Getting Started](https://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](https://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-indent --save-dev
```
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-indent');
```
## The "indent" task
### Overview
This task will let you increase or decrease the indentation of lines within files. It simply walks all of the lines in the specified files, adds or removes indents as you specify in the options, and saves the modified files to the location you want.
This is useful for building JavaScript projects where you want the built/concatenated files to have proper indentation.
### Options
#### options.style
Type: `String`
Default value: `tab`
The type of indentation to add or remove. The options are `tab` or `space`.
#### options.size
Type: `Number`
Default value: `1`
The number of `options.style` characters in an indent. For example, if you use 2 spaces per indent then you would set `options.style` to `space`, and this to `2`.
#### options.change
Type: `Number`
Default value: `0`
The indentation level change. If this is a positive number it will indent all lines the specified number of times. If this is a negative number it will remove the specified number of indents. If this number is zero then it will merely copy the files without modifying the contents.
### Usage Examples
#### Increase Indentation
In this example the indent task will increase the indent of all .js files in the src directory by one and save the modified files in the dist directory.
```js
grunt.initConfig({
indent: {
scripts: {
src: [
'src/*.js'
],
dest: 'dist/',
options: {
style: 'space',
size: 2,
change: 1
}
}
}
});
```
#### Decrease Indentation
In this example the indent task will decrease the indent of all .css files in the css directory by one and save the modified files in the dist directory.
```js
grunt.initConfig({
indent: {
stylesheets: {
src: [
'css/*.css'
],
dest: 'dist/',
options: {
style: 'space',
size: 2,
change: -1
}
}
}
});
```
## Release History
* 2017-04-22 v1.0.0 Increase min Node.js version to 0.10. Corrected "main" target.
* 2016-02-28 v0.1.5 Updated grunt peer dependency to support Grunt v1.0.
* 2013-11-08 v0.1.4 Added success message to grunt output.
* 2013-03-23 v0.1.3 Files will now be saved with Grunt defined line endings.
* 2013-03-21 v0.1.2 Fixed bug with empty lines when file uses Windows style line endings.
* 2013-03-17 v0.1.1 Added support for single-file destinations.
* 2013-03-16 v0.1.0 Initial release.