https://github.com/hex7c0/grunt-endline

add newline at end of file for Nodejs
https://github.com/hex7c0/grunt-endline

endline grunt-plugins nodejs

Last synced: about 1 month ago
JSON representation

add newline at end of file for Nodejs

• Host: GitHub
• URL: https://github.com/hex7c0/grunt-endline
• Owner: hex7c0
• License: gpl-3.0
• Created: 2014-08-31T15:30:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-04-15T22:08:33.000Z (over 1 year ago)
• Last Synced: 2024-04-13T19:19:45.370Z (9 months ago)
• Topics: endline, grunt-plugins, nodejs
• Language: JavaScript
• Homepage: https://github.com/hex7c0/grunt-endline
• Size: 151 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [grunt-endline](https://github.com/hex7c0/grunt-endline)

[![NPM version](https://img.shields.io/npm/v/grunt-endline.svg)](https://www.npmjs.com/package/grunt-endline)

[![Linux Status](https://img.shields.io/travis/hex7c0/grunt-endline.svg?label=linux-osx)](https://travis-ci.org/hex7c0/grunt-endline)

[![Dependency Status](https://img.shields.io/david/hex7c0/grunt-endline.svg)](https://david-dm.org/hex7c0/grunt-endline)

> Add newline at end of file if missing

## Getting Started

This plugin requires Grunt `^1.0.0`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://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-endline --save-dev

```

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

```js

grunt.loadNpmTasks('grunt-endline');

```

## The "endline" task

### Overview

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

```js

grunt.initConfig({

  endline: {

    options: {

      // Task-specific options go here.

    },

    your_target: {

      // Target-specific file lists and/or options go here.

    }

  }

});

```

### Options

#### options.footer

Type: `String | Number`

Default value: `\n`

Write newline at the end of file.

If is set a Number, replace `footer` X times.

#### options.src

Type: `String | Array`

Source path

#### options.dest

Type: `String | Array`

Default value: `false`

Destination path.

#### options.except

Type: `String | Array`

Default value: `false`

Except path from parsing.

Can hide "node_modules" from here.

#### options.replaced

Type: `Boolean`

Default value: `false`

Show file replaced.

### Usage Examples

#### Default Options

In this example, the default options are used.

```js

grunt.initConfig({

    endline: {

        default_options: {

            files: [ {

                src: 'test/target/with',

                dest: 'tmp/object'

            }, {

                src: 'test/target/without',

                dest: 'tmp/object'

            } ]

        }

    },

});

```

#### Custom Options

In this example, custom options are used to do save 5 newlines.

```js

grunt.initConfig({

    custom_options: {

        options: {

            footer: 5

        },

        files: {

            'tmp/multiple': [ 'test/target/*' ]

        }

    }

});

```

### [License GPLv3](LICENSE)