功能所需依赖 fs、glob、ssh2-sftp-clien
新建js文件，可放至build目录下
const fs = require('fs')
const glob = require('glob')
const Client = require('ssh2-sftp-client')
const sftp = new Client()
const pluginName = 'SftpPlugin'
class SftpPlugin {
// dir 本地目录格式 path.join(__dirname, '..', 'dist/')
constructor({ dir = '', url = '/', host = '192.168.*.*', port = '22', username = '', password = '', filterFile = null } = {}) { // constructor是一个构造方法，用来接收参数
this.url = url
this.dir = dir
this.filterFile = filterFile
this.config = {
host: host, // 服务器地址
port: port,
username: username,
password: password
}
}
apply(compiler) {
if (compiler) {
compiler.hooks.done.tap(pluginName, compilation => {
this.put()
})
} else {
this.put()
}
}
put() { // 自动上传到FTP服务器
if (!this.dir) {
console.error('无法上传SFTP,请检查参数')
return
}
sftp.connect(this.config).then(() => { // 连接服务器
sftp.list(this.url).then(list => {
this.deleteServerFile(list).then(() => {
this.globLocalFile()
})
}).catch(err => {
this.exError(err)
})
}).catch(err => {
this.exError('sftp连接失败' + err)
})
}
async deleteServerFile(list) { // 删除服务器上文件(夹)
for (const fileInfo of list) {
const path = this.url + fileInfo.name
if (fileInfo.type === '-') {
await sftp.delete(path)
} else {
await sftp.rmdir(path, true)
}
}
return new Promise(resovle => {
resovle()
})
}
globLocalFile() { // 获取本地路径所有文件
glob(this.dir + '**', (er, files) => { // 本地目录下所有文件(夹)的路径
files.splice(0, 1) // 删除路径../dist/
if (this.filterFile && typeof this.filterFile === 'function') files = files.filter(x => this.filterFile(x))
this.uploadFileToSftp(files)
})
}
async uploadFileToSftp(files) { // 传输文件到服务器
for (const localSrc of files) {
const targetSrc = localSrc.replace(this.dir.replace(/\\/g, '/'), this.url)
if (fs.lstatSync(localSrc).isDirectory()) { // 是文件夹
await sftp.mkdir(targetSrc)
} else {
await sftp.put(localSrc, targetSrc)
}
}
console.log('已上传至SFTP服务器!')
sftp.end()
}
exError(err) { // 出错请调用此方法
sftp.end()
console.error('sftpError:', err)
}
}
modules.export = SftpPlugin
在 项目中的 build/webpack.prod.conf.js 引入
const SftpPlugin = require('./SftpPlugin')
在plugin中
new SftpPlugin({ dir: path.join(__dirname, '..', 'dist/'), url: '/soft/nginx/', host: '192.168.*.*' })
注意: url为sftp服务所对应的你想要上传的地址，根据实际情况修改
最后, npm run build 就可以自动部署到ftp服务器了
