Merge pull request #261 from elistone/monitor-file

Monitor file

Author: yongkangchen

README.md

@@ -1,44 +1,40 @@
 # Atom Remote Sync
-
 This package provides functionality for:
-
-* Uploading changes automatically when you save a file
-* Uploading/downloading files to/from the server
-* Displaying diffs between the local and remote files with your favourite diff tool
-* set difftoolCommand in AtomSettingView of `remote-sync` — The path to your diff tool executable
+- Uploading changes automatically when you save a file
+- Uploading/downloading files to/from the server
+- Displaying diffs between the local and remote files with your favourite diff tool
+- Monitor files for external change and automatically upload
+- set difftoolCommand in AtomSettingView of `remote-sync` -- The path to your diff tool executable
 
 Currently, both SCP/SFTP and FTP are supported.
 
 ## Installation
-
 You can install this like any other Atom package, with one of these methods:
-
-* Open your settings in Atom, select the "Install" tab, search for "remote-sync", and click install on it
-* Run `apm install remote-sync` in a terminal
-* Download or clone this repository to your `~/.atom/packages/` directory and enter the directory run `apm install`
+- Open your settings in Atom, select the "Install" tab, search for "remote-sync", and click install on it
+- Run `apm install remote-sync` in a terminal
+- Download or clone this repository to your `~/.atom/packages/` directory and enter the directory run `apm install`
 
 ## Usage
-
 Create file `.remote-sync.json` in your project root with these settings:
-
-* `transport` — `scp` for SCP/SFTP, or `ftp` for FTP
-* `hostname` — Remote host address
-* `port` - Remort port to connect on (typically 22 for SCP/SFTP, 21 for FTP)
-* `username` — Remote host username
-* `password` — Remote host password
-* `keyfile` — Absolute path to SSH key (only used for SCP)
-* `passphrase` — Passphrase for the SSH key (only used for SCP)
-* `useAgent` — Whether or not to use an agent process, default: false (only used for SCP)
-* `target` — Target directory on remote host
-* `source` — Source directory relative to project root
-* `ignore` — Array of [minimatch](https://github.com/isaacs/minimatch) patterns of files to ignore
-* `uploadOnSave` — Whether or not to upload the current file when saved, default: false
-* `useAtomicWrites` — Upload file using a temporary filename before moving to its final location (only used for SCP), default: false
-* `uploadMirrors` — transport mirror config array when upload
-* `deleteLocal` - whether or not to delete the local file / folder after remote delete
-* `saveOnUpload` - Whether or not to save a modified file before uploading, default: false
+- `transport` -- `scp` for SCP/SFTP, or `ftp` for FTP
+- `hostname` -- Remote host address
+- `port` - Remort port to connect on (typically 22 for SCP/SFTP, 21 for FTP)
+- `username` -- Remote host username
+- `password` -- Remote host password
+- `keyfile` -- Absolute path to SSH key (only used for SCP)
+- `passphrase` -- Passphrase for the SSH key (only used for SCP)
+- `useAgent` -- Whether or not to use an agent process, default: false (only used for SCP)
+- `target` -- Target directory on remote host
+- `source` -- Source directory relative to project root
+- `ignore` -- Array of [minimatch](https://github.com/isaacs/minimatch) patterns of files to ignore
+- `uploadOnSave` -- Whether or not to upload the current file when saved, default: false
+- `useAtomicWrites` -- Upload file using a temporary filename before moving to its final location (only used for SCP), default: false
+- `uploadMirrors` -- transport mirror config array when upload
+- `deleteLocal` - whether or not to delete the local file / folder after remote delete
+- `saveOnUpload` - Whether or not to save a modified file before uploading, default: false
 
 SCP example:
+
 ```json
 {
   "transport": "scp",
@@ -57,6 +53,7 @@ SCP example:
 ```
 
 SCP `useAgent` example:
+
 ```json
 {
   "transport": "scp",
@@ -73,6 +70,7 @@ SCP `useAgent` example:
 ```
 
 FTP example:
+
 ```json
 {
   "transport": "ftp",
@@ -89,6 +87,7 @@ FTP example:
 ```
 
 Upload mirrors example:
+
 ```json
 {
   "transport": "scp",
@@ -114,7 +113,7 @@ Upload mirrors example:
       "passphrase": "your_passphrase",
       "target": "/home/vagrant/dirname/subdirname_one",
       "ignore": [
-	    ".remote-sync.json",
+        ".remote-sync.json",
         ".git/**"
       ]
     },
@@ -126,7 +125,7 @@ Upload mirrors example:
       "password": "vagrant",
       "target": "/home/vagrant/dirname/subdirname_two",
       "ignore": [
-	    ".remote-sync.json",
+        ".remote-sync.json",
         ".git/**"
       ]
     }
@@ -135,17 +134,14 @@ Upload mirrors example:
 ```
 
 ## Usage example
-
 ### Existing project
-
 1. Add a file named `.remote-sync.json` to your project, with the contents above
 2. Open the command palette by pressing cmd + shift + P on a Mac, or ctrl + shift + P on Linux/Windows
 3. Type in `remote sync reload config` and press enter
 
 That's it!
 
 ### From scratch, with a remote server
-
 1. Create a folder for your project, and create a file named `.remote-sync.json` in it with the contents above
 2. In the Atom editor, open the command palette by pressing cmd + shift + P on a Mac, or ctrl + shift + P on Linux/Windows
 3. Type in `remote sync reload config` and press enter
@@ -154,6 +150,5 @@ That's it!
 
 The package will download all of the files from the remote server for you.
 
-
-#Make a donation via Paypal ![Make a donation via Paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)
+# Make a donation via Paypal ![Make a donation via Paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)
 Click 'Send Money' after login PayPal, and my PayPal account is: lx1988cyk#gmail.com

index.coffee

@@ -95,6 +95,7 @@ module.exports =
       'remote-sync:diff-file': (e)-> handleEvent(e, "diffFile")
       'remote-sync:diff-folder': (e)-> handleEvent(e, "diffFolder")
       'remote-sync:upload-git-change': (e)-> handleEvent(e, "uploadGitChange")
+      'remote-sync:monitor-file': (e)-> handleEvent(e, "monitorFile")
       'remote-sync:configure': configure
     })
 

lib/RemoteSync.coffee

@@ -1,6 +1,7 @@
 
 path = require "path"
 fs = require "fs-plus"
+chokidar = require "chokidar"
 
 exec = null
 minimatch = null
@@ -15,6 +16,10 @@ Host = null
 HostView = null
 EventEmitter = null
 
+MonitoredFiles = []
+watcher        = chokidar.watch()
+
+
 logger = null
 getLogger = ->
   if not logger
@@ -29,7 +34,7 @@ class RemoteSync
     @host = new Host(@configPath)
     @initIgnore(@host)
     @projectPath = path.join(@projectPath, @host.source) if @host.source
-    
+
   initIgnore: (host)->
     ignore = host.ignore?.split(",")
     host.isIgnore = (filePath, relativizePath) =>
@@ -50,7 +55,7 @@ class RemoteSync
   inPath: (rootPath, localPath)->
     localPath = localPath + path.sep if fs.isDirectorySync(localPath)
     return localPath.indexOf(rootPath + path.sep) == 0
-    
+
   dispose: ->
     if @transport
       @transport.dispose()
@@ -93,7 +98,7 @@ class RemoteSync
         if e.getPath() is filePath and e.isModified()
           e.save()
           return if @host.uploadOnSave
-      
+
     uploadCmd.handleSave(filePath, @getTransport())
     for t in @getUploadMirrors()
       uploadCmd.handleSave(filePath, t)
@@ -102,6 +107,35 @@ class RemoteSync
     fs.traverseTree dirPath, @uploadFile.bind(@), =>
       return not @isIgnore(dirPath)
 
+  monitorFile: (dirPath)->
+    if dirPath not in MonitoredFiles
+      MonitoredFiles.push dirPath
+      watcher.add(dirPath);
+      _this = @
+      watcher.on('change', (path) ->
+        _this.uploadFile(path)
+      ).on 'unlink', (path) ->
+        log 'File', path, 'has been removed'
+    else
+      watcher.unwatch(dirPath)
+      index = MonitoredFiles.indexOf(dirPath);
+      MonitoredFiles.splice(index, 1)
+    @.monitorStyles()
+
+  monitorStyles: ()->
+    monitorClass  = 'file-monitoring'
+    monitored     = document.querySelectorAll '.'+monitorClass
+
+    if monitored != null and monitored.length != 0
+      for item in monitored
+        item.classList.remove monitorClass
+
+    for file in MonitoredFiles
+      file_name = file.replace(/(['"])/g, "\\$1");
+      icon_file = document.querySelector '[data-path="'+file_name+'"]'
+      list_item = icon_file.parentNode
+      list_item.classList.add monitorClass
+
   uploadGitChange: (dirPath)->
     repos = atom.project.getRepositories()
     curRepo = null

menus/context.cson

@@ -6,6 +6,7 @@
       {label: 'Download File', command: 'remote-sync:download-file'}
       {label: 'Diff File', command: 'remote-sync:diff-file'}
       {label: 'Delete File', command: 'remote-sync:delete-file'}
+      {label: 'Monitor File (Upload on External Save)', command: 'remote-sync:monitor-file'}
     ]
   ]
 

package.json

@@ -9,13 +9,14 @@
     "atom": ">=0.78"
   },
   "dependencies": {
-    "ssh2": "^0.2",
-    "minimatch": "^0.2",
     "async": "^0.2",
-    "mkdirp": "^0.3",
     "atom-message-panel": "^1.1.1",
     "atom-space-pen-views": "^2.0.3",
+    "chokidar": "^1.4.3",
     "fs-plus": "^2.1",
-    "ftp": "^0.3.7"
+    "ftp": "^0.3.7",
+    "minimatch": "^0.2",
+    "mkdirp": "^0.3",
+    "ssh2": "^0.2"
   }
 }

styles/monitor.less

@@ -0,0 +1,10 @@
+.file-monitoring{
+  &:after{
+    content: "M";
+    width: 25px;
+    height: 25px;
+    color: orange;
+    position: absolute;
+    right: 0px;
+  }
+}