@itkyk/ftp-controller

FTP Controller

How to use this module.

1. Npm module install

   $ npm i -D @itkyk/ftp-controller
   

2. Add scripts in package.json

       "script": {
         "ftp:init": "ftpController --init",
         "deploy:prev": "ftpController --deploy preview",
         "deploy:stg": "ftpController --deploy staging"
       }

3. Run npm init command

       $ npm run ftp:init
   

   This command is added template file of .env.
   We recommend that you rewrite file name of that template.
   ex) .env.template → .env.preview

4. deploy

   1. CLI
      1. Run npm deploy command

             $ npm run deploy:prev
         

   2. API
      1. Import this module 1.

         import deploy from "@itkyk/ftp-controller";
         deploy({
          key: "preview", // required
          list: false // not required. default is `false`.
         })

5. finished

• When complete, /ftp/ftp-upload.log will be output.

Options

option	value	description
--init, -i	-	Create template file of .envfile This option can't be used with other options.
--deploy, -d < value >	string	FTP deploy option. You give extension of .env file. (ex) .env.preview → --deploy preview
--list, -l	boolean	if true and when finish uploading, push log by console

Options of env

option	value	default (指定しなかった場合)	description
user	String	-	FTP ID
password	String	-	FTP pass word
host	String	-	FTP URL
port	Number	-	FTP access PORT
localRoot	String	/dist/	File upload destination path
remoteRoot	String	/htdocs/	Directory target to upload
include	Array	"*", "**/*"	Specify the file to upload. In the .env file, write as follows. include: "*, **/*"
exclude	Array	-	Specify the file that will not be uploaded. In the .env file, write as follows. include: "*, **/*"
deleteRemote	Boolean	false	Specifies whether to delete all existing files at the destination before uploading.
forcePasv	Boolean	false	Specifies whether passive mode enforces.
sftp	Boolean	false	Specifies whether to use SFTP.
privateKey	string	-	If you are using an SFTP connection and still need a pem key, enter the path to the pem key in this key.

使い方

1. npmをインストール

   $ npm i -D @itkyk/ftp-controller
   

2. package.jsonへスクリプトを追加

   "script": {
     "ftp:init": "ftpController --init",
     "deploy:prev": "ftpController --deploy preview",
     "deploy:stg": "ftpController --deploy staging"
   }

3. 追加したinitコマンドを叩く

   $ npm run ftp:init
   

   プロジェクトのルートディレクトリに/ftp/.env.templateが作成されます。 この作られたテンプレートの.envファイルを編集して設定ファイルを作成。
   例) .env.template → .env.preview

4. deployする

   1. CLI
      1. deployコマンドを叩く

             $ npm run deploy:prev
         

   2. API
      1. importして使う 1.

         import deploy from "@itkyk/ftp-controller";
         deploy({
          key: "preview", // required
          list: false // not required. default is `false`.
         })

5. 完了

   • 完了すると、/ftp/ftp-upload.logが出力されます。

Options

option	value	description
--init, -i	-	.envファイルのテンプレート作成 他optionとpの併用不可
--deploy, -d < value >	String	FTPアップ時のコマンドです。 .env後ろの拡張子をvalueとして与えてください。 (ex) .env.preview → --deploy preview
--list, -l	Boolean	trueにするとFTPアップ時にconsoleにアップしたファイルが表示されます。

envファイル設定

option	value	default (指定しなかった場合)	description
user	String	-	FTP ID
password	String	-	FTP pass word
host	String	-	FTP URL
port	Number	-	FTP access PORT
localRoot	String	/dist/	ファイルアップ先のパス
remoteRoot	String	/htdocs/	アップ先のディレクトリターゲット
include	Array	"*", "**/*"	アップするファイルを指定。 .envファイルでは以下のように記述してください。 include: "*, **/*"
exclude	Array	-	アップしないファイルを指定。 .envファイルでは以下のように記述してください。 include: "*, **/*"
deleteRemote	Boolean	false	アップロードする前に宛先にある既存のファイルをすべて削除するかどうか指定します。
forcePasv	Boolean	false	パッシブモードが強制するかどうか指定します。
sftp	Boolean	false	SFTPを使用するかどうか指定します。
privateKey	string	-	SFTP接続でなおかつpemキーが必要な場合、このキーにpemキーまでのパスを記入してください。