# unplugin-ftp-upload

> After you build your project, automatically upload the project to your service.

Latest version **0.1.5** (published 2023-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install unplugin-ftp-upload
pnpm add unplugin-ftp-upload
yarn add unplugin-ftp-upload
bun add unplugin-ftp-upload
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2023-03-16 |
| First published | 2023-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 33.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | legend0610 |
| Keywords | ftp, upload, pack, vite, webpack, rollup, transform |

## Links

- npm: https://www.npmjs.com/package/unplugin-ftp-upload
- Repository: https://github.com/legend402/unplugin-ftp-upload
- Homepage: https://github.com/legend402/unplugin-ftp-upload#readme
- Issues: https://github.com/legend402/unplugin-ftp-upload/issues
- npm.io page: https://npm.io/package/unplugin-ftp-upload

## Dependencies (3)

- [unplugin](https://npm.io/package/unplugin.md) ^1.0.1
- [ssh2-sftp-client](https://npm.io/package/ssh2-sftp-client.md) ^9.0.4
- [@types/ssh2-sftp-client](https://npm.io/package/@types/ssh2-sftp-client.md) ^9.0.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2023-03-16
- 0.1.4 — 2023-03-15
- 0.1.3 — 2023-03-15
- 0.1.2 — 2023-03-15
- 0.1.0 — 2023-03-15

## README

# unplugin-ftp-upload

[![NPM version](https://img.shields.io/npm/v/unplugin-ftp-upload?color=a1b858&label=)](https://www.npmjs.com/package/unplugin-ftp-upload)

After you build your project, automatically upload the project to your service.

## Usage

| options    | desc                                   | type   | default | must |
| ---------- | -------------------------------------- | ------ | ------- | ---- |
| host       | service host                           | string |         | ✅   |
| port       | service port                           | string |         | ✅   |
| username   | service username                       | string |         | ✅   |
| password   | service password                       | string |         | ✅   |
| serviceDir | website dir in your service            | string |         | ✅   |
| delay      | How long after the package is complete | number | 1500ms  | ❌   |
| backupPath | backup file path                       | string |         | ❌   |

other config, [look here](https://www.npmjs.com/package/ssh2-sftp-client)

## Install

```bash
npm i unplugin-ftp-upload
```

<details>
<summary>Vite</summary><br>

```ts
// vite.config.ts
import Starter from 'unplugin-ftp-upload/vite'

export default defineConfig({
  plugins: [
    Starter({ /* options */ }),
  ],
})
```

Example: [`playground/`](./playground/)

`<br></details>`

<details>
<summary>Webpack</summary><br>

```ts
// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('unplugin-ftp-upload/webpack')({ /* options */ })
  ]
}
```

`<br></details>`

<details>
<summary>Vue CLI</summary><br>

```ts
// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('unplugin-ftp-upload/webpack')({ /* options */ }),
    ],
  },
}
```

`<br></details>`

---
_Source: https://npm.io/package/unplugin-ftp-upload · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._