380 lines
13 KiB
JavaScript
380 lines
13 KiB
JavaScript
const fs = require('fs')
|
||
const path = require('path')
|
||
|
||
/** ******************* 读取命令行以及配置文件里的参数 ******************** **/
|
||
const commander = require('commander')
|
||
const deepmerge = require('deepmerge')
|
||
|
||
// 默认参数
|
||
const Config = {
|
||
deploy: {
|
||
from: './dist',
|
||
toTarget: 'connection',
|
||
|
||
connection: {
|
||
server: 'ssh',
|
||
host: undefined,
|
||
port: 22,
|
||
dir: undefined,
|
||
dist: 'dist',
|
||
repo: undefined,
|
||
branch: 'master',
|
||
gitname: undefined,
|
||
gitemail: undefined,
|
||
user: undefined,
|
||
password: undefined,
|
||
key: `${process.env.HOME}/.ssh/id_rsa`,
|
||
},
|
||
vultr: {
|
||
server: 'ssh',
|
||
host: undefined,
|
||
port: 22,
|
||
dir: undefined,
|
||
dist: 'dist',
|
||
user: undefined,
|
||
password: undefined,
|
||
key: `${process.env.HOME}/.ssh/id_rsa`,
|
||
},
|
||
github: {
|
||
server: 'git',
|
||
repo: undefined,
|
||
branch: 'master',
|
||
gitname: undefined,
|
||
gitemail: undefined,
|
||
user: undefined,
|
||
password: undefined,
|
||
key: `${process.env.HOME}/.ssh/id_rsa`,
|
||
}
|
||
}
|
||
}
|
||
|
||
// 读取配置文件
|
||
try {
|
||
let configFile
|
||
if (fs.existsSync(configFile=path.join(process.cwd(), 'ConfigDeploy.js'))) {
|
||
Config = deepmerge(Config, require(configFile))
|
||
console.info(`${configFile} loaded`)
|
||
}
|
||
} catch (err) {
|
||
console.error('Loading config files failed: ' + err.message)
|
||
}
|
||
Config.deploy.connection = Config.deploy[Config.deploy.toTarget]
|
||
|
||
// 读取命令行参数
|
||
commander
|
||
.version('1.0', '-v, --version') // 默认是 -V。如果要 -v，就要加 '-v --version'
|
||
.option('-f, --from <from>', `local path to copy from. Default to ${Config.deploy.from}`)
|
||
.option('-t, --toTarget <toTarget>', `connection section in config. Default to ${Config.deploy.toTarget}`)
|
||
|
||
.option('-s, --server <server>', `server type, git or ssh. Default to ${Config.deploy.connection.type}`)
|
||
|
||
.option('-H, --host <host>', `Host IP or domain name of the target server. Default to ${Config.deploy.connection.host}`)
|
||
.option('-P, --port <port>', `Ssh port number of the target server. Default to ${Config.deploy.connection.port}`)
|
||
.option('-D, --dir <dir>', `Destination path to deploy on the target server. Default to ${Config.deploy.connection.dir}`)
|
||
.option('-d, --dist <dist>', `Destination folder to deploy on the target server. Default to ${Config.deploy.connection.dist}`)
|
||
|
||
.option('-r, --repo <repo>', `git repo address. Default to ${Config.deploy.connection.repo}`)
|
||
.option('-b, --branch <branch>', `git repo branch. Default to ${Config.deploy.connection.branch}`)
|
||
.option('-n, --gitname <gitname>', `git user name. Default to ${Config.deploy.connection.gitname}`)
|
||
.option('-e, --gitemail <gitemail>', `git user email. Default to ${Config.deploy.connection.gitemail}`)
|
||
|
||
.option('-u, --user <user>', `User id to login the target server. Default to ${Config.deploy.connection.user}`)
|
||
.option('-k, --key <key>', `User private key file to login the target server. Default to ${Config.deploy.connection.key}`)
|
||
.option('-p, --password <password>', `User password to login the target server. You may have to enclose it in "". Default to "${Config.deploy.connection.password}"`)
|
||
.parse(process.argv)
|
||
|
||
Config.deploy.from = commander.from || Config.deploy.from
|
||
Config.deploy.connection = Config.deploy[commander.toTarget || Config.deploy.toTarget] // 使用用户指定的连接
|
||
|
||
const connection = {
|
||
server: commander.server || Config.deploy.connection.server,
|
||
|
||
host: commander.host || Config.deploy.connection.host,
|
||
port: commander.port || Config.deploy.connection.port,
|
||
dir: commander.dir || Config.deploy.connection.dir, // 目标服务器上的目录。似乎该目录必须已经存在于服务器上
|
||
dist: commander.dist || Config.deploy.connection.dist, // 新系统将发布在这个文件夹里。建议为dist，和npm run build产生的目录一致，这样既可以远程自动部署，也可以直接登录服务器手动部署。
|
||
|
||
repo: commander.repo || Config.deploy.connection.repo,
|
||
branch: commander.branch || Config.deploy.connection.branch,
|
||
gitname: commander.gitname || Config.deploy.connection.gitname,
|
||
gitemail: commander.gitemail || Config.deploy.connection.gitemail,
|
||
|
||
username: commander.user || Config.deploy.connection.user,
|
||
privateKey: fs.existsSync(commander.key || Config.deploy.key) ? (commander.key || Config.deploy.key) : undefined,
|
||
password: commander.password || Config.deploy.connection.password,
|
||
tryKeyboard: true,
|
||
onKeyboardInteractive: (name, instructions, instructionsLang, prompts, finish) => { // 不起作用
|
||
if (prompts.length > 0 && prompts[0].prompt.toLowerCase().includes('password')) {
|
||
finish([password])
|
||
}
|
||
},
|
||
}
|
||
|
||
console.log(` deploy from ${Config.deploy.from} to ${JSON.stringify(connection)}`)
|
||
|
||
if (connection.type==='ssh') {
|
||
deployToSsh(connection)
|
||
}else if (connection.type==='git'){
|
||
deployToGit(connection)
|
||
}
|
||
|
||
/** ********************** 连接到 Ssh主机，拷贝文件到指定路径 ************* **/
|
||
function deployToSsh(connection){
|
||
const ssh = new (require('node-ssh'))()
|
||
|
||
function subDirs (path) {
|
||
const dirs = [path]
|
||
if (fs.statSync(path).isFile()) {
|
||
return dirs
|
||
}
|
||
fs.readdirSync(path).forEach(item => {
|
||
const stat = fs.statSync(`${path}/${item}`)
|
||
if (stat.isDirectory()) {
|
||
dirs.push(...subDirs(`${path}/${item}`))
|
||
}
|
||
})
|
||
return dirs
|
||
}
|
||
|
||
const necessaryPath = (path) => {
|
||
return subDirs(path)
|
||
.map(it => it.replace(path, ''))
|
||
.filter(it => it)
|
||
.map(it => it.split('/').filter(it => it))
|
||
}
|
||
|
||
ssh.connect(connection).then(async () => {
|
||
console.log(`[ mv ${connection.dist} ${connection.dist}-backup-${new Date().toISOString()} ... ]`)
|
||
await ssh.execCommand(`mv ${connection.dist} ${connection.dist}-backup-${new Date().toISOString()}`, { cwd: connection.dir })
|
||
console.log(`[ mkdir ${connection.dist} ... ]`)
|
||
await ssh.execCommand(`mkdir ${connection.dist}`, { cwd: connection.dir })
|
||
const toCreate = necessaryPath(path.join('./', Config.deploy.from))
|
||
for (const name of toCreate) {
|
||
console.log(`[ mkdir ${connection.dist}/${name.join('/')} ... ]`)
|
||
await ssh.execCommand(`mkdir ${connection.dist}/${name.join('/')}`, { cwd: connection.dir })
|
||
}
|
||
|
||
let err
|
||
console.log(`[ Upload to ${connection.dir}/${connection.dist} ... ]`)
|
||
await ssh.putDirectory(path.join('./', Config.deploy.from), `${connection.dir}/${connection.dist}`, {
|
||
concurrency: 10,
|
||
recursive: true,
|
||
validate: itemPath => {
|
||
const baseName = path.basename(itemPath)
|
||
return !baseName.endsWith('.map')
|
||
},
|
||
tick: (fromPath, remotePath, error) => {
|
||
console.log(`Uploading "${fromPath}" ===> "${remotePath}" ${error || 'succeeded!'}`)
|
||
err = error
|
||
},
|
||
})
|
||
ssh.dispose()
|
||
if (err) {
|
||
console.log('[ Uploaded with error! ]')
|
||
process.exit(1)
|
||
} else {
|
||
console.log('[ Uploaded successfully! ]')
|
||
}
|
||
}).catch(err => {
|
||
console.error(err)
|
||
ssh.dispose()
|
||
process.exit(1)
|
||
})
|
||
}
|
||
|
||
/** ********************** 连接到 Git主机，拷贝文件到指定路径 ************* **/
|
||
function deployToGit(connection){
|
||
const pathFn = require('path')
|
||
const fs = require('hexo-fs')
|
||
const chalk = require('chalk')
|
||
const swig = require('swig-templates')
|
||
const moment = require('moment')
|
||
const Promise = require('bluebird')
|
||
const spawn = require('hexo-util/lib/spawn')
|
||
|
||
const swigHelpers = {
|
||
now: function(format) {
|
||
return moment().format(format)
|
||
}
|
||
}
|
||
|
||
const rRepoURL = /^(?:(?:git|https?|git\+https|git\+ssh):\/\/)?(?:[^@]+@)?([^\/]+?)[\/:](.+?)\.git$/ // eslint-disable-line no-useless-escape
|
||
const rGithubPage = /\.github\.(io|com)$/
|
||
|
||
function parseRepo(repo) {
|
||
const split = repo.split(',')
|
||
const url = split.shift()
|
||
let branch = split[0]
|
||
|
||
if (!branch && rRepoURL.test(url)) {
|
||
const match = url.match(rRepoURL)
|
||
const host = match[1]
|
||
const path = match[2]
|
||
|
||
if (host === 'github.com') {
|
||
branch = rGithubPage.test(path) ? 'master' : 'gh-pages'
|
||
} else if (host === 'coding.net') {
|
||
branch = 'coding-pages'
|
||
}
|
||
}
|
||
|
||
return {
|
||
url: url,
|
||
branch: branch || 'master'
|
||
}
|
||
}
|
||
|
||
function parseConnection(args) {
|
||
const repo = args.repo || args.repository
|
||
if (!repo) throw new TypeError('repo is required!')
|
||
|
||
if (typeof repo === 'string') {
|
||
const data = parseRepo(repo)
|
||
data.branch = args.branch || data.branch
|
||
|
||
return [data]
|
||
}
|
||
|
||
const result = Object.keys(repo).map(key => {
|
||
return parseRepo(repo[key])
|
||
})
|
||
|
||
return result
|
||
}
|
||
|
||
function exec() {
|
||
const baseDir = ''
|
||
const deployDir = pathFn.join(baseDir, '.deploy_git')
|
||
const publicDir = Config.deploy.from
|
||
let extendDirs = connection.extend_dirs
|
||
const ignoreHidden = connection.ignore_hidden
|
||
const ignorePattern = connection.ignore_pattern
|
||
const message = commitMessage(connection)
|
||
const verbose = !connection.silent
|
||
|
||
if (!connection.repo && process.env.HEXO_DEPLOYER_REPO) {
|
||
connection.repo = process.env.HEXO_DEPLOYER_REPO
|
||
}
|
||
|
||
if (!connection.repo && !connection.repository) {
|
||
let help = ''
|
||
|
||
help += 'You have to configure the deployment settings in config files or command line first!\n\n'
|
||
help += 'Example:\n'
|
||
help += ' node deploy.js -t git -r https://github.com/OWNER/OWNER.github.io -b master -f ./dist'
|
||
|
||
console.log(help)
|
||
return
|
||
}
|
||
|
||
function git(...connection) {
|
||
return spawn('git', connection, {
|
||
cwd: deployDir,
|
||
verbose: verbose,
|
||
stdio: 'inherit'
|
||
})
|
||
}
|
||
|
||
function setup() {
|
||
const userName = Config.deploy.gitname || ''
|
||
const userEmail = Config.deploy.gitemail || ''
|
||
|
||
// Create a placeholder for the first commit
|
||
return fs.writeFile(pathFn.join(deployDir, 'placeholder'), '').then(() => {
|
||
return git('init')
|
||
}).then(() => {
|
||
return userName && git('config', 'user.name', userName)
|
||
}).then(() => {
|
||
return userEmail && git('config', 'user.email', userEmail)
|
||
}).then(() => {
|
||
return git('add', '-A')
|
||
}).then(() => {
|
||
return git('commit', '-m', 'First commit')
|
||
})
|
||
}
|
||
|
||
function push(repo) {
|
||
return git('add', '-A').then(() => {
|
||
return git('commit', '-m', message).catch(() => {
|
||
// Do nothing. It's OK if nothing to commit.
|
||
})
|
||
}).then(() => {
|
||
return git('push', '-u', repo.url, 'HEAD:' + repo.branch, '--force')
|
||
})
|
||
}
|
||
|
||
return fs.exists(deployDir).then(function(exist) {
|
||
if (exist) return
|
||
|
||
// log.info('Setting up Git deployment...')
|
||
return setup()
|
||
}).then(() => {
|
||
// log.info('Clearing .deploy_git folder...')
|
||
return fs.emptyDir(deployDir)
|
||
}).then(() => {
|
||
const opts = {}
|
||
// log.info('Copying files from public folder...')
|
||
if (typeof ignoreHidden === 'object') {
|
||
opts.ignoreHidden = ignoreHidden.public
|
||
} else {
|
||
opts.ignoreHidden = ignoreHidden
|
||
}
|
||
|
||
if (typeof ignorePattern === 'string') {
|
||
opts.ignorePattern = new RegExp(ignorePattern)
|
||
} else if (typeof ignorePattern === 'object' && Reflect.apply(Object.prototype.hasOwnProperty, ignorePattern, ['public'])) {
|
||
opts.ignorePattern = new RegExp(ignorePattern.public)
|
||
}
|
||
|
||
return fs.copyDir(publicDir, deployDir, opts)
|
||
}).then(() => {
|
||
// log.info('Copying files from extend dirs...')
|
||
|
||
if (!extendDirs) {
|
||
return
|
||
}
|
||
|
||
if (typeof extendDirs === 'string') {
|
||
extendDirs = [extendDirs]
|
||
}
|
||
|
||
const mapFn = function(dir) {
|
||
const opts = {}
|
||
const extendPath = pathFn.join(baseDir, dir)
|
||
const extendDist = pathFn.join(deployDir, dir)
|
||
|
||
if (typeof ignoreHidden === 'object') {
|
||
opts.ignoreHidden = ignoreHidden[dir]
|
||
} else {
|
||
opts.ignoreHidden = ignoreHidden
|
||
}
|
||
|
||
if (typeof ignorePattern === 'string') {
|
||
opts.ignorePattern = new RegExp(ignorePattern)
|
||
} else if (typeof ignorePattern === 'object' && Reflect.apply(Object.prototype.hasOwnProperty, ignorePattern, [dir])) {
|
||
opts.ignorePattern = new RegExp(ignorePattern[dir])
|
||
}
|
||
|
||
return fs.copyDir(extendPath, extendDist, opts)
|
||
}
|
||
|
||
return Promise.map(extendDirs, mapFn, {
|
||
concurrency: 2
|
||
})
|
||
}).then(() => {
|
||
return parseConnection(connection)
|
||
}).each(function(repo) {
|
||
console.log('########## repo ###########')
|
||
console.log(repo)
|
||
return push(repo)
|
||
})
|
||
} // end of function exec
|
||
|
||
function commitMessage(connection) {
|
||
const message = connection.m || connection.msg || connection.message || 'Site updated: {{ now(\'YYYY-MM-DD HH:mm:ss\') }}'
|
||
return swig.compile(message)(swigHelpers)
|
||
}
|
||
|
||
exec()
|
||
|
||
} |