sftp-uploader (English version)

sftp-uploader-eng is a file upload plug-in based on ssh2-sftp-client encapsulation, supporting webpack and vite. It can upload the packaged project files to the specified sftp server directory with one click. It can be integrated as a webpack or vite plug-in or used separately, and supports automatic creation of upload directories.

Install

$ yarn add sftp-uploader-eng
$ npm i sftp-uploader-eng

Note

This version is only available for node "^18.0.0 || >=20.0.0"

Configuration

import { resolve } from 'path'
import SftpUploader from 'sftp-uploader-eng'

const sftp = SftpUploader({
    dir: resolve('./dist'), // Directory to upload files
    serverPath: '******', // Directory to upload from root of the server
    host: '*****', // sftp address
    port: '*****', // sftp port
    username: '*****', // Account
    password: '*****', // Password
    // Delay upload time (milliseconds) to solve the problem that some projects will trigger multiple packaging completions
    delay: 0,
    //Allow patterns to match files/directories that start with '.'
    dot: false,
    //If true, then environment variable UPLOAD will be ignored.
    autoupload: false,
    // Upload file filter, you can filter out unnecessary files, return false to not upload the file (optional)
    uploadFilter(file) {
        return true;
    },
    // Delete file filter, you can filter out files that do not need to be deleted, return false to not delete the file (optional)
    deleteFilter(file) {
        return false;
    },
    // Preview link address (optional)
    previewPath: 'https://www.google.com'
})

Use

Use with the packaging command

// Used in webpack
//vue.config.js
module.exports = {
  configureWebpack: config => {
    return {
      plugins: [
        SftpUploader({ ... })
      ]
    }
  }
}

//Used in vite
//vite.config.js
export default defineConfig({
  plugins: [
    SftpUploader({ ... })
  ]
})

// package.json
// 1. Windows environment
"scripts": {
  "build": "vue-cli-service build --mode development",
  "deploy": "set UPLOAD=true && yarn build"
}
// 2. Linux or MacOS environment
"scripts": {
  "build": "vue-cli-service build --mode development",
  "deploy": "export UPLOAD=true && yarn build"
}
// Use yarn deploy or npm run deploy

Upload any project

// 1. Create uploader.js in the project
// 2. The configuration is the same as the webpack plugin mode
SftpUploader({ ... }).put()
// Then run the following command in the project root directory terminal
node uploader.js