A Node.js package to help with deploying code. Ftp a folder from your local disk to a remote ftp destination. Does not delete from destination directory.
Version 2.0.0 is an almost complete re-write to use promises and promise-ftp instead of jsftp. The one breaking change is listed in the notes of Usage section.
npm install --save-dev ftp-deploy
The most basic usage:
var FtpDeploy = ;var ftpDeploy = ;var config =user: "user"// Password optional, prompted if none givenpassword: "password"host: "ftp.someserver.com"port: 21localRoot: __dirname + "/local-folder"remoteRoot: "/public_html/remote-folder/"// include: ["*", "**/*"], // this would upload everything except dot filesinclude: "*.php" "dist/*" ".*"// e.g. exclude sourcemaps, and ALL files in node_modules (including dot files)exclude: "dist/**/*.map" "node_modules/**" "node_modules/**/.*" ".git/**"// delete ALL existing files at destination before uploading, if truedeleteRemote: false// Passive mode is forced (EPSV command is not sent)forcePasv: true;// use with promisesftpDeploy;// use with callbackftpDeploy;
- in version 2 the config file expects a field of
- The config file is passed as-is to Promise-FTP.
- I create a file - e.g. deploy.js - in the root of my source code and add a script to its
package.jsonso that I can
npm run deploy.
Configuration include and exclude
These are lists of minimatch globs. ftp-deploy works by checking for each file in your sourece directory, whether it is included by one of the include patterns and whether it is NOT excluded by one of the exclude patterns. In other words:
include: all files that match will be uploaded. Note that a
[ ]matches nothing
exclude: if a file matches the include pattern a subset may nonetheless be excluded
ftp-deploy reports to clients using events. To get the output you need to implement watchers for "uploading", "uploaded" and "log":
A script to run a simple ftp server (using ftp-srv) is included, together with a test directory.
To use open a console to run the ftp server:
npm run server
and then in another console run the tests:
- re-enable continueOnError
- update newer files only (PR welcome)