V3.1.0 (#611)

* german localization * corrected naming of locale * german localization * corrected naming of locale * fix: missing partial i18n translation * fix: missing partial i18n translation * fix: add missing key for German language file * fix: typo * Minor Wording Changes The text on some parts looked strange and not correct, thought I'd update a few for grammar and looks. * chore: update .gitignore * chore: add tslint and prettier rules * chore: add format script * chore: update teslint rules to make it defined mutilple class in one file * chore: run tslint before publish extension * refactor: format the code with prettier * chore: update tsconfig and tslint * refactor: refactor utils.ts * refactor: refactor localize.ts * refactor: refactor setting.ts * refactor: refactor environmentPath.ts * refactor: refactor fileService.ts * chore: update teslint rules * refactor: replace github package with @octokit/rest * chore: update teslint rules * refactor: refactor commons.ts * refactor: refactor pluginService.ts * refactor: extension.ts * feat: replace fs module with fs-extra, and use async await instead of callback style * feat: update deps for vscode/typescript/adm-zip/tslint * refactor: refactor callback style with async await * remove unused dependencies ncp and rimraf, use fs-extra instead * fix: invalid @octokit/rest constructor options * chore: update travis script * fix: lstat should be async no sync * fix: user agent for proxy * pref: improve performance when start up. use async instead of sync method #472 * fix: implement promisify and fix lockfile * feat: use lockfile instead of proper-lockfile. * pref: improve performance * refactor: add sync class and clean up extension file. it should improve startup performance #472 * refactor: add lockfile.ts * fix: typo ShowSummaryOutput * refactor: refactor download function * fix: lockfile * refactor: rename 'en' to 'env' * refactor: remove unused activationEvents * refactor: refactor upload logic, make it clean * style: rename lockfile function name, make it same style with other * refactor: sync advance options * chore: not allow unuser locals and params. make it clean * refactor: remove unused local and params * refactor: remove unneed await * pref: improve localize performance, init when extension be actived * fix: make sure resolve language merger with default language. * Update tutorial message * Fix slack img * Update path to imgur link * Update tutorial link again * Extension Installation CLI Added TSLint Improved #434 #590 #513 #337 * Summary improved * Github Api Code Improvements Anonymous Gist Code Removed Initializtion in contructor github api updated proxy addition github enterprise support updated * Ignored extensions can be accidentally deleted if removeExtensions is enabled. (#604) * Fix for #516 * Update to fix `ignoredExtensions` where extensions were deleted if `removeExtensions` was enabled. * #604 * Extension summary #577 * Gist Name change #513 * #611 * fix: error translation * #611 - Changelog CLI Improvements * #611 * #611
shanalikhan · Aug 26, 2018 · 174c739 · 174c739
1 parent 1dcc0db
commit 174c739
Show file tree

Hide file tree

Showing 23 changed files with 3,081 additions and 2,547 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,7 @@
 out
 node_modules
 *.vsix
-package-lock.json
+package-lock.json
+*.lock
+package-lock.json
+*.log
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,8 @@ before_install:
 install:
   - vsce package
 script:
-  - echo "npm test temporarily disabled"
+  - npm run tslint-check
+  - npm run compile
 
 deploy:
   provider: script

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+#### Version - 3.1.0
+* Option to Install Extensions Using CLI [#434](https://github.com/shanalikhan/code-settings-sync/issues/434)
+    - Code Team hasn't provided API to install extension, but as CLI is available Settings Sync will start using code cli to download extensions. Live Status will be displayed while downloading.
+    - Note : This feature wont work in Mac as I cant test on Mac. You will be facing problems, for this I need Mac users to help and fix it.
+    - Fixes : [#337](https://github.com/shanalikhan/code-settings-sync/issues/337), [#566](https://github.com/shanalikhan/code-settings-sync/issues/566) and [#577](https://github.com/shanalikhan/code-settings-sync/issues/577)
+* Unify the code style by using tslint and prettier - Thanks for PR [#595](https://github.com/shanalikhan/code-settings-sync/pull/595) by [@axetroy](https://github.com/axetroy)
+    - Fixes : [#578](https://github.com/shanalikhan/code-settings-sync/issues/578), [#597](https://github.com/shanalikhan/code-settings-sync/issues/597), [#486](https://github.com/shanalikhan/code-settings-sync/issues/486) by upgrading all the packages like Github Api.
+* Don't introduce "sync.*" settings which is equal to default behavior after DL/UL - [#513](https://github.com/shanalikhan/code-settings-sync/issues/513)
+    - Settings Sync configuration has been changed, Readme is updated.
+* Added German localization - Thanks for PR [#588](https://github.com/shanalikhan/code-settings-sync/pull/588) by [@ljosberinn](https://github.com/ljosberinn)
+* Missing partial i18n translation - Thanks for PR [#593](https://github.com/shanalikhan/code-settings-sync/pull/593) by [@axetroy](https://github.com/axetroy)
+* Documentation Improvement - Thanks for PR [#603](https://github.com/shanalikhan/code-settings-sync/pull/603) by [@MastaCoder](https://github.com/MastaCoder)
+* Fix slack img in README and Update tutorial message - Thanks for PR [#607](https://github.com/shanalikhan/code-settings-sync/pull/607) and [#608](https://github.com/shanalikhan/code-settings-sync/pull/608) by [@fr3fou](https://github.com/fr3fou)
+* Ignored extensions can be accidentally deleted if removeExtensions is enabled. - Thanks for PR [#604](https://github.com/shanalikhan/code-settings-sync/pull/604) by [@leepowellcouk](https://github.com/leepowellcouk)
+* Error Translation - Thanks for PR [#616](https://github.com/shanalikhan/code-settings-sync/pull/616) by [@Xiongqi-XQ](https://github.com/Xiongqi-XQ)
+
 #### Version - 3.0.0
 
 * Bug Fix for OSS Variant  [#549](https://github.com/shanalikhan/code-settings-sync/issues/549) - Thanks for PR [@rudfoss](https://github.com/rudfoss)
@@ -6,18 +22,7 @@
 * Setting to disable opening of github page [#576](https://github.com/shanalikhan/code-settings-sync/pull/576)
 * Update adm-zip to the latest version [#551](https://github.com/shanalikhan/code-settings-sync/pull/551)
 
-
-#### Version - 2.9.2
-
-* Critical Bug Fix - Extension Download Fails [#540](https://github.com/shanalikhan/code-settings-sync/issues/540)
-
-
-#### Version - 2.9.1
-
-* Bug Fix for OSS Variant  [#510](https://github.com/shanalikhan/code-settings-sync/issues/510) - Thanks for PR [@JacobHenner](https://github.com/JacobHenner)
-* Readme Typo Fix [#531](https://github.com/shanalikhan/code-settings-sync/issues/531) - Thanks for PR [@x4m3](https://github.com/x4m3)
-* syncLocalSettings does not support replacing setting with "False" value [#516](https://github.com/shanalikhan/code-settings-sync/issues/516) - Thanks for PR [@leepowellcouk](https://github.com/leepowellcouk)
-* add support for xdg environment paths [#532](https://github.com/shanalikhan/code-settings-sync/pull/532) - Thanks for PR [@Dennor](https://github.com/Dennor)
+For Previous releases change log view the [post](http://shanalikhan.github.io/2016/05/14/Visual-studio-code-sync-settings-release-notes.html)
 
 
 ## [Contributions](https://github.com/shanalikhan/code-settings-sync/blob/master/CONTRIBUTING.md)
@@ -30,13 +35,12 @@ I also welcome financial contributions in case of special feature requests on my
 
 ### Community
 
-You may join slack community and disscus the ideas over there and chat with me.
+You may join slack community and disscus the ideas over there.
 
 <a href="https://join.slack.com/t/codesettingssync/shared_invite/enQtMzE3MjY5NTczNDMwLTYwMTIwNGExOGE2MTJkZWU0OTU5MmI3ZTc4N2JkZjhjMzY1OTk5OGExZjkwMDMzMDU4ZTBlYjk5MGQwZmMyNzk">
-<img src="https://shanalikhan.github.io/img/slack.PNG" alt="Drawing" style="width: 150px;"/>
+<img src="https://i.imgur.com/1QWdtcX.png" alt="Drawing" style="width: 150px;"/>
 </a>
 
 I'm looking for contributors to work with me so we can make the extension smoother and more feature rich.
 Let me know if anyone is willing to [contribute](https://github.com/shanalikhan/code-settings-sync/blob/master/CONTRIBUTING.md).
 
-For Previous releases change log view the [post](http://shanalikhan.github.io/2016/05/14/Visual-studio-code-sync-settings-release-notes.html)
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 [![Follow](https://img.shields.io/twitter/follow/itsShanKhan.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=itsShanKhan)
 
 <a href="https://join.slack.com/t/codesettingssync/shared_invite/enQtMzE3MjY5NTczNDMwLTYwMTIwNGExOGE2MTJkZWU0OTU5MmI3ZTc4N2JkZjhjMzY1OTk5OGExZjkwMDMzMDU4ZTBlYjk5MGQwZmMyNzk">
-<img src="https://shanalikhan.github.io/img/slack.PNG" alt="Drawing" style="width: 150px;"/>
+<img src="https://i.imgur.com/1QWdtcX.png" alt="Drawing" style="width: 150px;"/>
 </a>
 
 
@@ -22,7 +22,7 @@
 1. Use your GitHub account token and Gist.
 2. Easy to Upload and Download on one click.
 3. Show a summary page at the end with details about config and extensions effected.
-4. Auto Download Latest Settings on Startup.
+4. Auto download Latest Settings on Startup.
 5. Auto upload Settings on file change.
 6. Share the Gist with other users and let them download your settings.
 7. Supports GitHub Enterprise
@@ -36,7 +36,7 @@ All extensions and complete User Folder that Contains
 2. Keybinding File
 3. Launch File
 4. Snippets Folder
-5. VSCode Extensions Settings
+5. VSCode Extensions & Extensions Configurations
 6. Workspaces Folder
 ```
 
@@ -46,9 +46,6 @@ All extensions and complete User Folder that Contains
 2. Download Key : Shift + Alt + D
 ```
 
-
-
-
 ## Steps To Get a Personal Access Token from GitHub
 
 This extension requires a Personal Access Token from your GitHub account. You can create one by simply following the steps shown in the pictures below. Make sure you add **Gist** in scope.
@@ -172,46 +169,61 @@ Other users can give your Gist Id to download the Gist, but they can't upload th
 
 ## Settings
 
+There are two types of settings in Settings Sync.
+I will recommend you to read the configurations details [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753).
 
-For details regarding settings keys, click [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753)
+### Gist Settings
+
+Gist Settings are stored in `settings.json` file of Code.
+You can customize the settings in gist settings like:
+
+```
+1. Configure Gist Id (Environment)
+2. Configure auto upload / download for Github Gist 
+3. Configure extension sync behaviour
+4. Configure force download
+5. Configure quiet sync
+```
 
 ```json
     "sync.gist": "0c929b1a6c51015cdc9e0fe2e369ea4c",
-    "sync.lastUpload": "2018-03-04T14:21:39.841Z",
     "sync.autoDownload": false,
     "sync.autoUpload": false,
-    "sync.lastDownload": "2018-03-04T14:21:39.841Z",
-    "sync.forceDownload": true,
-    "sync.host": "",
-    "sync.pathPrefix": "",
+    "sync.forceDownload": false,
     "sync.quietSync": false,
     "sync.askGistName": false,
     "sync.removeExtensions": true,
     "sync.syncExtensions": true
 ```
 
-## Customized Sync
+### Global Settings
+
+Global settings are present in `syncLocalSettings.json` inside `User` folder. These settings will be shared across multiple Gist Environments.
+
+On Windows, this is `%APPDATA%\Code\User\syncLocalSettings.json`.
 
-Extension will create the `syncLocalSettings.json` inside `User` folder upon code start. <br>
-On Windows, this is `%APPDATA%\Code\User\syncLocalSettings.json`. <br>
-Mac, `$HOME/Library/Application Support/Code/User/syncLocalSettings.json`. <br>
-Linux, `~/.config/Code/User/syncLocalSettings.json`. <br>
+Mac, `$HOME/Library/Application Support/Code/User/syncLocalSettings.json`.
+
+Linux, `~/.config/Code/User/syncLocalSettings.json`.
 
 You can customize the sync:
 
 ```
 1. Options by which files / folders and settings to exclude from upload.
-2. The Gist Description when creating new Gist.
+2. Configure default Gist Environment name.
 3. Replace the code settings after downloading.
 4. Change the Gist description while creating new one in github.
+5. Configure Github Enterprise Url
 ```
 
-The JSON will be created as:
-
 ```json
 {
-    "ignoreUploadFiles": [ "projects.json", "projects_cache_vscode.json",
-        "projects_cache_git.json", "projects_cache_svn.json", "gpm_projects.json",
+    "ignoreUploadFiles": [
+        "projects.json",
+        "projects_cache_vscode.json",
+        "projects_cache_git.json",
+        "projects_cache_svn.json",
+        "gpm_projects.json",
         "gpm-recentItems.json"
     ],
     "ignoreUploadFolders": [
@@ -221,19 +233,25 @@ The JSON will be created as:
         "ignored_extension_name"
     ],
     "replaceCodeSettings": {
-         "http.proxy": "http://my.proxy.address:8080"
+        "http.proxy": "http://my.proxy.address:8080"
     },
     "gistDescription": "Visual Studio Code Settings Sync Gist",
-    "version": 290,
+    "version": 310,
     "token": "YOUR_GITHUB_TOKEN_HERE",
     "downloadPublicGist": false,
     "supportedFileExtensions": [
-        "json", "code-snippets"
-    ]
+        "json",
+        "code-snippets"
+    ],
+    "openTokenLink": true,
+    "useCliBaseInstallation": true,
+    "lastUpload": null,
+    "lastDownload": null,
+    "githubEnterpriseUrl": null
 }
 ```
 
-For settings details, visit my post [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753)
+I will recommend you to read the configurations details [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753).
 
 
 ## How To Contribute

diff --git a/images/slack.png b/images/slack.png
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "code-settings-sync",
     "displayName": "Settings Sync",
     "description": "Synchronize Settings, Snippets, Themes, File Icons, Launch, Keybindings, Workspaces and Extensions Across Multiple Machines Using GitHub Gist.",
-    "version": "3.0.0",
+    "version": "3.1.0",
     "icon": "images/cloud.png",
     "publisher": "Shan",
     "author": {
@@ -60,12 +60,7 @@
         "multi-root ready"
     ],
     "activationEvents": [
-        "*",
-        "onCommand:extension.updateSettings",
-        "onCommand:extension.downloadSettings",
-        "onCommand:extension.resetSettings",
-        "onCommand:extension.HowSettings",
-        "onCommand:extension.otherOptions"
+        "*"
     ],
     "main": "./out/src/extension",
     "contributes": {
@@ -108,16 +103,6 @@
                     "default": "",
                     "description": "%ext.config.gist%"
                 },
-                "sync.lastUpload": {
-                    "type": "string",
-                    "default": "",
-                    "description": "%ext.config.lastUpload%"
-                },
-                "sync.lastDownload": {
-                    "type": "string",
-                    "default": "",
-                    "description": "%ext.config.lastDownload%"
-                },
                 "sync.autoDownload": {
                     "type": "boolean",
                     "default": false,
@@ -133,16 +118,6 @@
                     "default": false,
                     "description": "%ext.config.forceDownload%"
                 },
-                "sync.host": {
-                    "type": "string",
-                    "default": "",
-                    "description": "%ext.config.host%"
-                },
-                "sync.pathPrefix": {
-                    "type": "string",
-                    "default": "",
-                    "description": "%ext.config.pathPrefix%"
-                },
                 "sync.quietSync": {
                     "type": "boolean",
                     "default": false,
@@ -168,25 +143,29 @@
         }
     },
     "scripts": {
-        "vscode:prepublish": "npm run compile",
+        "vscode:prepublish": "npm run tslint-check && npm run compile",
         "compile": "tsc -p ./",
         "watch": "tsc -watch -p ./",
-        "postinstall": "node ./node_modules/vscode/bin/install"
+        "postinstall": "node ./node_modules/vscode/bin/install",
+        "tslint-check": "tslint -c ./tslint.json ./src/**/*.ts ./src/*.ts",
+        "format": "prettier --write './src/**/*.ts'"
     },
     "devDependencies": {
-        "typescript": "^2.8.3",
-        "vscode": "^1.1.6",
-        "@types/node": "^10.0.3"
+        "@types/fs-extra": "^5.0.4",
+        "@types/node": "^10.7.0",
+        "prettier": "^1.14.2",
+        "tslint": "^5.11.0",
+        "tslint-plugin-prettier": "^1.3.0",
+        "typescript": "^3.0.1",
+        "vscode": "^1.1.21"
     },
     "dependencies": {
-        "adm-zip": "0.4.7",
+        "@octokit/rest": "^15.10.0",
+        "adm-zip": "^0.4.11",
         "chokidar": "^2.0.2",
-        "fs": "^0.0.2",
-        "github": "^11.0.0",
+        "fs-extra": "^7.0.0",
         "https-proxy-agent": "^2.1.1",
-        "ncp": "^2.0.0",
-        "proper-lockfile": "^2.0.1",
-        "rimraf": "^2.6.2",
+        "lockfile": "^1.0.4",
         "temp": "^0.8.3"
     }
 }