Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/happycoda/grunt-remote-exists

Grunt plugin to check remote file existence
https://github.com/happycoda/grunt-remote-exists

grunt grunt-plugins plugins

Last synced: 3 days ago
JSON representation

Grunt plugin to check remote file existence

Host: GitHub
URL: https://github.com/happycoda/grunt-remote-exists
Owner: happyCoda
License: mit
Created: 2016-02-03T20:21:00.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-02-05T15:41:10.000Z (almost 9 years ago)
Last Synced: 2024-11-07T17:11:07.371Z (about 2 months ago)
Topics: grunt, grunt-plugins, plugins
Language: JavaScript
Size: 11.7 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT

Awesome Lists containing this project

README

# grunt-remote-exists

> Check if file exists on remote server

## Getting Started
This plugin requires Grunt `~0.4.5`

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-remote-exists --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-remote-exists');
```

## The "remote_exists" task

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

```js
grunt.initConfig({
remote_exists: {
options: {
operation: null,
connectOpts: {
host: 'hostname',
port: 22,
username: 'username',
passphrase: 'passphrase',
privateKey: 'privateKey'
}
},
your_target: {
src: ['/remote/path/to/file']
},
},
});
```

### Options

#### filePath
Type: `String`
Default value: `none`

A path to file on a remote server to check if it exists.

#### operation
Type: `String` of `null`
Default value: `null`

String which tells plugin whether it should create, remove or just check file.

#### connectOpts
Type: `Object` of `null`
Default value: `null`

An object with ssh connection params.

### Usage Examples

#### Just checking
In this example, the default options for file creation are used. So the file specified in `filePath` will be checked on the remote `host`, and result of this checking will be outputted to the console.

```js
grunt.initConfig({
remote_exists: {
options: {
filePath: '/remote/path/to/file',
connectOpts: {
host: 'hostname',
port: 22,
username: 'username',
passphrase: 'passphrase',
privateKey: 'privateKey'
}
}
}
});
```

#### Write
If `filePath` does not exist, it will be created since `touch` option is enabled. Checking results will be outputted as well.

```js
grunt.initConfig({
remote_exists: {
options: {
operation: 'touch',
connectOpts: {
host: 'hostname',
port: 22,
username: 'username',
passphrase: 'passphrase',
privateKey: 'privateKey'
}
},
default_config: {
src: ['/remote/path/to/file']
}
}
});
```

#### Remove
If `filePath` exists, it will be removed, nothing will be done otherwise. Checking results will be outputted as well.

```js
grunt.initConfig({
remote_exists: {
options: {
operation: 'rm',
connectOpts: {
host: 'hostname',
port: 22,
username: 'username',
passphrase: 'passphrase',
privateKey: 'privateKey'
}
},
default_config: {
src: ['/remote/path/to/file']
}
}
});
```

## Release History
* 2016-02-05 v1.1.0 Tests are rewritten. File removal bug fixed. Multiple file support added.
* 2016-02-04 v1.0.0 All logic completely rewritten.
* 2016-02-03 v0.1.0 First official release.