Package Exports
- ftp-simple
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ftp-simple) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
##Function
- Directly Open, Edit and Save on server files.
- Save the local file or directory to server(=upload and backup option)
- Download the file or directory from ftp server.
- Create a directory on the remote server directly.
- Delete directory(recursive) and files directly from the server.
- Compare a local file server file.
- Remote directory open to workspace (Beta version)
##Available commands
- config - Set the ftp connection information.
- create directory - Create a directory on ftp server.
- open - Open the file directly from ftp server and when you save upload it to the ftp server.
- save - File or directory upload to ftp server.(Available from the context menu)
- download - Download the file or directory from ftp server to the workspace.
- delete - Delete the file or directory directly from ftp server.
- diff - Compare a local file server file.
- Remote directory open to workspace - (Beta version) Open the direcotry directly on workspace from ftp server. Similar to remote synchronization. (Caution : Remote delete a files is only possible using 'Delete' in the context menu)
##Startup Settings
- Press 'F1'
- Enter 'ftp-simple'
- Pick 'CONFIG'
- Enter ftp connection information and save
##Config setting example See the easy-ftp details.
- name - string - Display name.
- host - string - server domain or ip.
- port - number - (option) port (Default: : 21)
- type - string - (option) ftp type. 'ftp' or 'sftp' (Default: : 'ftp')
- username - string - username for authentication.
- password - string - (option) password for authentication.
- privateKey - string - (option) sftp only. String that contains a private key for either key-based or hostbased user authentication (OpenSSH format) Default: none
- passphrase - string - (option) Use sftp 'privateKey' only. For an encrypted private key, this is the passphrase used to decrypt it. Default: none
- path - string - (option) remote root path. Default: '/'
- autosave - boolean - (option) To determine whether the automatically uploaded when you open a file directly and modify and save. Default: true
- backup - string - (option) The local path you want to back up before file saving on the server.
- confirm - boolean - (option) Only save option. When you save the file, ask if you want to overwrite the file if it already exists.. Default: true
- project - object - (option) Only save option. Pre-specify local workspace path and server root path to save directly without selecting a path. Overwrite unconditionally.
- ignore - array - (option) Only 'Remote directory open to workspace' option. Path to be ignore. Use glog pattern. (Caution : server path (ex:
/home) + ignore pattern (ex:/**/node_modules) =>/home/**/node_modules)
Example
[
{
"name": "my server1",
"host": "127.0.0.1",
"port": 21,
"type": "ftp",
"username": "id",
"password": "pw",
"path" : "/"
},
{
"name": "my server2",
"host": "127.0.0.1",
"port": 22,
"type": "sftp",
"username": "id",
"password": "pw",
"path" : "/",
"autosave" : false
},
{
"name": "my server3",
"host": "127.0.0.1",
"port": 21,
"type": "sftp",
"username": "id",
"password": "pw",
"path" : "/home",
"confirm" : false,
"backup" : "C:/backup",
"project" : {
"c:/projects/project1" : "/home/user/project",
"c:/projects/project2" : {"path":"/home/user/project2", "save":true} //When the "save" value is "true", save immediately without confirm
},
"ignore" : ["/**/node_modules", "/**/*.class"]
},
....
]##Remote Config(option) "File - Preferences - Settings" and type in the format shown below.
- ftp-simple.remote-workspace - string - (option) You can modify the local workspace path when you open a remote file. Modify this option if remote file encoding is not UTF-8.(VSCode appears to have encoding recognition bugs if the workspace path is longer.)
- ftp-simple.remote-workspace-load-all - boolean - (option) Indicates whether all files are loaded during initial run. If false, the sub folder ([DIR]) will load when it is clicked. Default: true
Example
"ftp-simple" : {
"remote-workspace" : "c:/remote-workspace",
"remote-workspace-load-all" : true
}