PulsarSync

Although Microsoft has buried Atom (which, as we all know, is quite typical for this company - to buy competitors projects and shut them down), the community still continues to develop the project under a different name - Pulsar. So it's time to bring new ftp|sftp syncing-package for them.

One of the most useful additions for Atom was remote-sync, which for some reason was not updated and did not fix bugs. I fixed his mistakes in order to continue using this add-on, because. it is quite convenient. At the same time I rewrote everything into simple JS.

So what is it?

PulsarSync let you use SFTP and FTP features inside Pulsar, having the ability to upload and download files directly from Tree-view. PulsarSync is a revision of two projects: remote-sync which was abandoned in 2016 and remote-sync-pro which fixed some of the bugs of the first package. In my version several bugs have been fixed, and support for keepalive connections has been added.

Features

Uploading/downloading files to/from the server
Monitoring files for external changes and automatically uploading - useful for scss/less compiling
Support for both SCP/SFTP and FTP

Extras

Toggle for uploading changes automatically when you save a file
Define files to be monitored
Toggle the logs for extra information
Toggle the hiding and showing of the log panel
Set custom config name
Support for native Pulsar Notifications

Manual installation

If you need to install a package without the package subsystem, make next steps:

Download / clone this repository to your /home/user/.atom/packages/pulsar-sync
Enter the directory
Run ppm install (in Atom it was apm)

Please note that the finish folder must be named exactly "pulsar-sync", because ppm packages (as and npm too) don't recognize large and small characters.

Usage

You can configure PulsarSync by next ways:

Existing project

Via Pulsar (recommended)

Right click main project folder
Navigate to PulsarSync > Configure
Fill in the details / select options
Hit save

Manually

Add a file named .sync.json to your project
Add/configure with one of the contents below
Save the file

Options

The .sync.json in your project root will use these options:

Option	Datatype	Default	Details
`transport`	String	""	`scp` for SCP/SFTP, or `ftp` for FTP
`hostname`	String	""	Remote host address
`port`	String	""	Remort port to connect on (typically 22 for SCP/SFTP, 21 for FTP)
`username`	String	""	Remote host username
`password`	String	""	Remote host password
`keyfile`	String	""	Absolute path to SSH key (only used for SCP)
`secure`	Boolean	false	Set to true for both control and data connection encryption (only used for FTP)
`passphrase`	String	""	Passphrase for the SSH key (only used for SCP)
`useAgent`	String	false	Whether or not to use an agent process (only used for SCP)
`target`	String	""	Target directory on remote host
`source`	String	""	Source directory relative to project root
`ignore`	Array	[".sync.json",".git/**"]	Array of minimatch patterns of files to ignore
`watch`	Array	[]	Array of files (relative to project root - starting with "/") to watch for changes
`keepalive`	Integer	0	Number of seconds to wait between two keepalive
`uploadMirrors`	Array	[]	Transport mirror config array when upload
`uploadOnSave`	Boolean	false	Whether or not to upload the current file when saved
`saveOnUpload`	Boolean	false	Whether or not to save a modified file before uploading
`usePulsaricWrites`	Boolean	false	Upload file using a temporary filename before moving to its final location (only used for SCP)
`deleteLocal`	Boolean	false	Whether or not to delete the local file / folder after remote delete

Example configuration's

SCP example:

{
  "transport": "scp",
  "hostname": "10.10.10.10",
  "port": 22,
  "username": "user",
  "password": "pass",
  "keyfile": "/home/user/.ssh/aws.pem",
  "passphrase": "your_passphrase",
  "target": "/home/user/dirname/subdirname",
  "ignore": [ ".sync.json", ".git/**" ],
  "watch":[
    "/css/styles.css",
    "/index.html"
  ],
  "keepalive": 60
}

SCP `useAgent` example:

{
  "transport": "scp",
  "hostname": "10.10.10.10",
  "port": 22,
  "username": "user",
  "useAgent": true,
  "target": "/home/user/dirname/subdirname",
  "ignore": [ ".sync.json", ".git/**" ],
  "watch":[
    "/css/styles.css",
    "/index.html"
  ],
  "keepalive": 60
}

FTP example:

{
  "transport": "ftp",
  "hostname": "10.10.10.10",
  "port": 21,
  "username": "user",
  "password": "pass",
  "target": "/home/user/dirname/subdirname",
  "ignore": [ ".git/**" ],
  "watch":[
    "/css/styles.css",
    "/index.html"
  ],
  "keepalive": 60
}

Upload mirrors example:

{
  "transport": "scp",
  "hostname": "10.10.10.10",
  "port": 22,
  "username": "user",
  "password": "pass",
  "keyfile": "/home/user/.ssh/aws.pem",
  "passphrase": "your_passphrase",
  "target": "/home/user/dirname/subdirname",
  "ignore": [ ".git/**" ],
  "watch":[
    "/css/styles.css",
    "/index.html"
  ],
  "uploadMirrors":[
    {
      "transport": "scp",
      "hostname": "10.10.10.10",
      "port": 22,
      "username": "user",
      "password": "pass",
      "keyfile": "/home/user/.ssh/aws.pem",
      "passphrase": "your_passphrase",
      "target": "/home/user/dirname/subdirname_one",
      "ignore": [ ".git/**" ]
    },
    {
      "transport": "ftp",
      "hostname": "10.10.10.10",
      "port": 21,
      "username": "user",
      "password": "pass",
      "target": "/home/user/dirname/subdirname_two",
      "ignore": [ ".git/**" ]
    }
  ]
}