https://github.com/s00d/folder-upload-webpack-plugin

https://github.com/s00d/folder-upload-webpack-plugin

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/s00d/folder-upload-webpack-plugin
• Owner: s00d
• Created: 2019-10-04T11:53:39.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-14T15:56:11.000Z (almost 2 years ago)
• Last Synced: 2024-11-19T02:53:00.002Z (about 2 months ago)
• Language: JavaScript
• Size: 336 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# folder-upload-webpack-plugin

> Upload your folder to ftp/sftp server easier and faster

![](https://img.shields.io/npm/v/folder-upload-webpack-plugin.svg)

[![NPM](https://nodei.co/npm/folder-upload-webpack-plugin.png)](https://nodei.co/npm/folder-upload-webpack-plugin/)

## Installation

```bash

npm i -D folder-upload-webpack-plugin

```

## Usage

add following code to your webpack config file.

```javascript

const FolderUploadWebpackPlugin = require('folder-upload-webpack-plugin');

let webpackConfig = {

  entry: 'index.js',

  output: {

    path: 'assets',

    filename: 'index_bundle.js'

  },

  plugins: [

    new FolderUploadWebpackPlugin({

      confirmation: true,

      server: {host: 'ip', port: '22', username: 'username', password: 'password'},

      paths: () => {

        let data = [];

        data[path.resolve(__dirname, "build_/")] = path.join(".../build/");

        return data;

      },

      clear: true,

      logging: false,

    })

  ]

}

```

### Options Detail:

Option Name|Usage|Type|Default Value

---|:--:|:--:|:-:

confirmation|show confirmation before upload|Boolean|false

server|ssh config for options(or Array, to multiple servers) you can see [docs](https://github.com/mscdex/ssh2#client-methods)|Object|{port:22}

paths|function - return object {local: remote}, see path example|Function|(none)

clear|optional clear server folder before upload|Boolean|true

logging|optional show log|Boolean|false

symlink|create local symlink, after upload|object|null

### Extend Options Detail:

Option Name|Usage|Type|Default Value

---|:--:|:--:|:-:

ssh|optional ssh class|Class|see code

chmod|optional compress level|Octal|0o644

before|optional array with command|Array|[]

after|optional array with command|Array|[]

for other options you can see  https://github.com/mscdex/ssh2#client-methods

## path example

```

... 

paths: () => {

    let data = [];

    data[path.resolve(__dirname, "build_/")] = path.join("...build/");

    return data;

},...

```

## Change Log

### 2.4.0

```

- fix ts

```

### 2.1.0

```

- add after and before command

```

### 2.0.0

```

- replace paths. see Options

- remove pathsClear && remotePath

```

### 1.1.0

```

- change upload type

```

### 1.0.0

```

- init

```