Bumped version to v1.16.0

Merge pull request #246 from Natizyskunk/develop

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.16.0 - 2022-10-29
+* [#242] Add order option and fix typos in docs (Pull request [#157](https://github.com/Natizyskunk/vscode-sftp/pull/157) from @NyaPPuu vscode-sftp:add_order_option).
+* [#243] Fix refresh when creating/deleting file/folder + Fix 'Reveal in Remote Explorer' and Refresh Button in Remote Explorer. (Pull request [#159](https://github.com/Natizyskunk/vscode-sftp/pull/159) from @NyaPPuu vscode-sftp:fix_refresh).
+* [#244] Add order option and fix typos in docs (Pull request [#213](https://github.com/Natizyskunk/vscode-sftp/pull/213) from @BrayFlex vscode-sftp:develop).
+
 ## 1.15.20 - 2022-08-28
 * Fix typo 'worksapce' to 'workspace' (Pull request [#158](https://github.com/Natizyskunk/vscode-sftp/pull/158) from @NyaPPuu vscode-sftp:fix_typo).
 * Add `Download File` & `Downalod Folder` commands to the remote view (Thanks to @mrandrey on issue #97).

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to vscode-sftp
 
-After you've created a branch on your fork with your changes, it's time to [make a pull request][pr-link]. 
+After you've created a branch on your fork with your changes, [open a pull request][pr-link]. 
 
 *Please follow the guidelines given below while making a Pull Request to the vscode-sftp*
 
@@ -14,7 +14,7 @@ After you've created a branch on your fork with your changes, it's time to [make
 * Please make sure you squash all commits together before opening a pull request. If your pull request requires changes upon review, please be sure to squash all additional commits as well. [This wiki page][squash-link] outlines the squash process.
 * Target your Pull Request to the `master` branch of the `vscode-sftp`
 
-Once you’ve submitted a pull request, the collaborators can review your proposed changes and decide whether or not to incorporate (pull in) your changes.
+Once you've submitted a pull request, the collaborators can review your proposed changes and decide whether or not to incorporate (pull in) your changes.
 
 ### Pull Request Pro Tips
 
@@ -28,7 +28,7 @@ and for others to understand and maintain in the future.
 
 ### Open Pull Requests
 
-Once you’ve opened a pull request, a discussion will start around your proposed changes.
+Once you've opened a pull request, a discussion will start around your proposed changes.
 
 Other contributors and users may chime in, but ultimately the decision is made by the collaborators.
 

FAQ.md

@@ -13,8 +13,8 @@
 ## Error: Failure
 
 The failure error message comes from the remote side and is more or less the default/generic error 
-message that SSH' sftp server sends when a syscall fails or something similar happens.
-To know what exactly is going wrong you could try to enable debug output for the sftp server, 
+message that sftp server sends when a syscall fails or something similar happens.
+To know what exactly is going wrong you could try to enable debug output for the sftp server 
 and then execute your transfers again and see what (if anything) shows up in the logs there.
 
 ### Error: Failure - Solution One
@@ -23,13 +23,13 @@ Change `remotePath` to the actual path if it's a symlink.
 
 ### Error: Failure - Solution Two
 
-The problem would be that your server runs out of file descriptors.
+The problem could be that your server runs out of file descriptors.
 You should try to increase the file descriptors limit.
 If you don't have the permission to do this, set [limitOpenFilesOnRemote](https://github.com/Natizyskunk/vscode-sftp/wiki/Configuration#limitopenfilesonremote) option in your config.
 
 ## Error: Connection closed
 
-The problem would be that the SFTP extension keeps closing the connection for those who use more legacy/old systems.
+The problem could be that the SFTP extension keeps closing the connection for those who use more legacy/old systems.
 You'll have to Explicitly override the default transport layer algorithms used for the connection to remove the new `"diffie-hellman-group-exchange-sha256"` algorithm that cause the problem from the `kex` section. Just add this in your `sftp.json` configuration file, which should make it work.
 ```json
 {
@@ -145,7 +145,7 @@ See [vscode-sftp issue #136](https://github.com/Natizyskunk/vscode-sftp/issues/1
   "remotePath": "/folder1/folder2/folder3",
   "uploadOnSave": false, // Set to false if watcher `autoUpload` is set to true & `files` is set to "**/*".
   "watcher": {
-    "files": **/*",
+    "files": "**/*",
     "autoUpload": true,
     "autoDelete": true
   }

README.md

@@ -1,18 +1,14 @@
 # sftp sync extension for VS Code
 
-New version by [@Natizyskunk](https://github.com/Natizyskunk/) that just work 😀 <br>
-(This was originally a fork from [liximomo's SFTP plugin](https://github.com/liximomo/vscode-sftp.git))
+Maintained and updated version by [@Natizyskunk](https://github.com/Natizyskunk/) 😀 <br>
+(Forked from the no longer maintained [liximomo's SFTP plugin](https://github.com/liximomo/vscode-sftp.git))
 
 - VS Code marketplace : https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp <br>
 - VSIX release : https://github.com/Natizyskunk/vscode-sftp/releases/
 
 ---
 
-Syncs your local directory with a remote server directory.
-Allows you to optionally edit upload a file to the remote directory after it saves locally. 
-This allows you to edit more or less directly on the server similar to WinScp or other similar programs.
-
-Very powerful, with smart features. Very simple, requires just three lines of configuration! Very fast, finished in a blink.
+VSCode-SFTP enables you to add, edit or delete files within a local directory and have it sync to a remote server directory using different transfer protocols like FTP or SSH. The most basic setup requires only a few lines of configuration with a wide array of specific settings also available to meet the needs of any user. Both powerful and fast, it helps developers save time by allowing the use of a familiar editor and environment. 
 
 - Features
   - [Browser remote with Remote Explorer](#remote-explorer)
@@ -32,18 +28,18 @@ Very powerful, with smart features. Very simple, requires just three lines of co
 
 ### Method 1 (Recommended : Auto update)
 1. Select Extensions (Ctrl + Shift + X).
-2. Uninstall current sftp extension from @liximomo
-3. Install new extension directly from VS Code Marketplace : https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp
-4. Voilà !
+2. Uninstall current sftp extension from @liximomo.
+3. Install new extension directly from VS Code Marketplace : https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp.
+4. Voilà!
 
 ### Method 2 (Manual update)
-To install it just follow thoses steps from within VSCode :
+To install just follow these steps from within VSCode:
 1. Select Extensions (Ctrl + Shift + X).
-2. Uninstall current sftp extension from @liximomo
-3. Open "More Action” menu(ellipsis on the top) and click “Install from VSIX…”.
+2. Uninstall current sftp extension from @liximomo.
+3. Open "More Action" menu(ellipsis on the top) and click "Install from VSIX…".
 4. Locate VSIX file and select.
 5. Reload VSCode.
-6. Voilà !
+6. Voilà!
 
 ## Documentation
 - [Home](https://github.com/Natizyskunk/vscode-sftp/wiki)
@@ -54,16 +50,15 @@ To install it just follow thoses steps from within VSCode :
 - [Commands](https://github.com/Natizyskunk/vscode-sftp/wiki/Commands)
 
 ## Usage
-If your latest files are on the server, you can start with an empty local folder,
+If the latest files are already on a remote server, you can start with an empty local folder,
 then download your project, and from that point sync.  
 
 1. In `VS Code`, open a local directory you wish to sync to the remote server (or create an empty directory 
-that you wish to first download the contents of a remote server folder in order to edit locally). 
+that you wish to first download the contents of a remote server folder in order to edit locally).
 2. `Ctrl+Shift+P` on Windows/Linux or `Cmd+Shift+P` on Mac open command palette, run `SFTP: config` command.
-3. A basic configuration file will appear named `sftp.json` under the `.vscode` directory.
-Edit the parameters to match your setup.
+3. A basic configuration file will appear named `sftp.json` under the `.vscode` directory, open and edit the configuration parameters with your remote server information.
 
-For instance: 
+For instance:
 ```json
 {
     "name": "Profile Name",
@@ -77,22 +72,20 @@ For instance:
     "uploadOnSave": false
 }
 ```
-The password parameter is optional but if you don't add it, you will be constantly prompted for a password.
-Note that you must escape any backslashes and other special characters with a backslash.
-
-There are other Example configurations below.
+The password parameter in `sftp.json` is optional, if left out you will be prompted for a password on sync.
+_Note：_ backslashes and other special characters must be escaped with a backslash.
 
-3. Save and close the `sftp.json` file.
-4. `Ctrl+Shift+P` on Windows/Linux or `Cmd+Shift+P` on Mac open command palette.
-5. Type "sftp" and you'll now see a number of other comands.
-6. A good one to start with if you want to start with a remote folder is `SFTP: Download Project`.  This will download the directory shown in the `remotePath` setting in `sftp.json` to your local open directory. 
-7. Done - you can now edit locally and after each save it will upload to your remote file. 
-8. Enjoy !
+4. Save and close the `sftp.json` file.
+5. `Ctrl+Shift+P` on Windows/Linux or `Cmd+Shift+P` on Mac open command palette.
+6. Type `sftp` and you'll now see a number of other commands. You can also access many of the commands from the project's file explorer context menus.
+7. A good one to start with if you want to sync with a remote folder is `SFTP: Download Project`.  This will download the directory shown in the `remotePath` setting in `sftp.json` to your local open directory. 
+8. Done - you can now edit locally and after each save it will upload to sync your remote file with the local copy. 
+9. Enjoy!
 
-For detailed usage. Please go to [wiki](https://github.com/Natizyskunk/vscode-sftp/wiki).
+For detailed explanations please go to [wiki](https://github.com/Natizyskunk/vscode-sftp/wiki).
 
 ## Example configurations
-You can see the full configuration [here](https://github.com/Natizyskunk/vscode-sftp/wiki/configuration).
+You can see the full list of configuration options [here](https://github.com/Natizyskunk/vscode-sftp/wiki/configuration).
 
 - [sftp sync extension for VS Code](#sftp-sync-extension-for-vs-code)
   - [Installation](#installation)
@@ -182,7 +175,7 @@ _Note：_ `name` is required in this mode.
 ### Connection Hopping
 You can connect to a target server through a proxy with ssh protocol.
 
-_Note：_ **Variable substitution is not working in a hop configuration.**
+_Note：_ Variable substitution is not working in a hop configuration.
 
 #### Single Hop
 local -> hop -> target
@@ -279,6 +272,17 @@ You can only view a files content with Remote Explorer. Run command `SFTP: Edit
 
 _Note：_ You need to manually refresh the parent folder after you **delete** a file to make the explorer updated.
 
+You can order the remote Explorer by adding the `remoteExplorer.order` parameter inside your `sftp.json` config file.
+
+In sftp.json:
+```json
+{
+  "remoteExplorer": {
+    "order": 1 // <-- Default value is 0.
+  }
+}
+```
+
 ## Debug
 1. Open User Settings.
   - On Windows/Linux - `File > Preferences > Settings`
@@ -290,7 +294,7 @@ _Note：_ You need to manually refresh the parent folder after you **delete** a
 You can see all the Frequently Asked Questions [here](./FAQ.md).
 
 ## Donation
-If this project helped you reduce development time, you can give me a cup of coffee :)
+If this project helped you reduce development time and you wish to contribute financially
 
 ### Buy Me a Coffee
 [![Buy Me A Coffee](https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png)](https://www.buymeacoffee.com/Natizyskunk)

docs/common_configuration.md

@@ -28,7 +28,7 @@ Use this when you want to map a subfolder to the `remotePath`.
 ## password
 *string*: The password for password-based user authentication (**note: this is stored as plain-text**).
 
-## remtoePath
+## remotePath
 *string*: The absolute path on the remote host.
 
 **default**: `/`
@@ -104,6 +104,11 @@ Set `uploadOnSave` to false when you watch everything.
 *string[]*: Configure that patterns for excluding files and folders.
 The Remote Explorer decides which files and folders to show or hide based on this setting.
 
+## remoteExplorer.order
+*number*: Remote Explorer will ascending sorting by this value. If the values are the same, sort by name.
+
+**default**: 0
+
 ## concurrency
 *number*: Lowering the concurrency could get more stability because some clients/servers have some sort of configured/hard coded limit.