Skip to content

Commit 174c739

Browse files
authored
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
1 parent 1dcc0db commit 174c739

23 files changed

+3081
-2547
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
out
22
node_modules
33
*.vsix
4-
package-lock.json
4+
package-lock.json
5+
*.lock
6+
package-lock.json
7+
*.log

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ before_install:
1212
install:
1313
- vsce package
1414
script:
15-
- echo "npm test temporarily disabled"
15+
- npm run tslint-check
16+
- npm run compile
1617

1718
deploy:
1819
provider: script

CHANGELOG.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
#### Version - 3.1.0
2+
* Option to Install Extensions Using CLI [#434](https://github.com/shanalikhan/code-settings-sync/issues/434)
3+
- 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.
4+
- 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.
5+
- 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)
6+
* 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)
7+
- 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.
8+
* Don't introduce "sync.*" settings which is equal to default behavior after DL/UL - [#513](https://github.com/shanalikhan/code-settings-sync/issues/513)
9+
- Settings Sync configuration has been changed, Readme is updated.
10+
* Added German localization - Thanks for PR [#588](https://github.com/shanalikhan/code-settings-sync/pull/588) by [@ljosberinn](https://github.com/ljosberinn)
11+
* Missing partial i18n translation - Thanks for PR [#593](https://github.com/shanalikhan/code-settings-sync/pull/593) by [@axetroy](https://github.com/axetroy)
12+
* Documentation Improvement - Thanks for PR [#603](https://github.com/shanalikhan/code-settings-sync/pull/603) by [@MastaCoder](https://github.com/MastaCoder)
13+
* 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)
14+
* 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)
15+
* Error Translation - Thanks for PR [#616](https://github.com/shanalikhan/code-settings-sync/pull/616) by [@Xiongqi-XQ](https://github.com/Xiongqi-XQ)
16+
117
#### Version - 3.0.0
218

319
* 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 @@
622
* Setting to disable opening of github page [#576](https://github.com/shanalikhan/code-settings-sync/pull/576)
723
* Update adm-zip to the latest version [#551](https://github.com/shanalikhan/code-settings-sync/pull/551)
824

9-
10-
#### Version - 2.9.2
11-
12-
* Critical Bug Fix - Extension Download Fails [#540](https://github.com/shanalikhan/code-settings-sync/issues/540)
13-
14-
15-
#### Version - 2.9.1
16-
17-
* Bug Fix for OSS Variant [#510](https://github.com/shanalikhan/code-settings-sync/issues/510) - Thanks for PR [@JacobHenner](https://github.com/JacobHenner)
18-
* Readme Typo Fix [#531](https://github.com/shanalikhan/code-settings-sync/issues/531) - Thanks for PR [@x4m3](https://github.com/x4m3)
19-
* 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)
20-
* add support for xdg environment paths [#532](https://github.com/shanalikhan/code-settings-sync/pull/532) - Thanks for PR [@Dennor](https://github.com/Dennor)
25+
For Previous releases change log view the [post](http://shanalikhan.github.io/2016/05/14/Visual-studio-code-sync-settings-release-notes.html)
2126

2227

2328
## [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
3035

3136
### Community
3237

33-
You may join slack community and disscus the ideas over there and chat with me.
38+
You may join slack community and disscus the ideas over there.
3439

3540
<a href="https://join.slack.com/t/codesettingssync/shared_invite/enQtMzE3MjY5NTczNDMwLTYwMTIwNGExOGE2MTJkZWU0OTU5MmI3ZTc4N2JkZjhjMzY1OTk5OGExZjkwMDMzMDU4ZTBlYjk5MGQwZmMyNzk">
36-
<img src="https://shanalikhan.github.io/img/slack.PNG" alt="Drawing" style="width: 150px;"/>
41+
<img src="https://i.imgur.com/1QWdtcX.png" alt="Drawing" style="width: 150px;"/>
3742
</a>
3843

3944
I'm looking for contributors to work with me so we can make the extension smoother and more feature rich.
4045
Let me know if anyone is willing to [contribute](https://github.com/shanalikhan/code-settings-sync/blob/master/CONTRIBUTING.md).
4146

42-
For Previous releases change log view the [post](http://shanalikhan.github.io/2016/05/14/Visual-studio-code-sync-settings-release-notes.html)

README.md

Lines changed: 45 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![Follow](https://img.shields.io/twitter/follow/itsShanKhan.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=itsShanKhan)
1111

1212
<a href="https://join.slack.com/t/codesettingssync/shared_invite/enQtMzE3MjY5NTczNDMwLTYwMTIwNGExOGE2MTJkZWU0OTU5MmI3ZTc4N2JkZjhjMzY1OTk5OGExZjkwMDMzMDU4ZTBlYjk5MGQwZmMyNzk">
13-
<img src="https://shanalikhan.github.io/img/slack.PNG" alt="Drawing" style="width: 150px;"/>
13+
<img src="https://i.imgur.com/1QWdtcX.png" alt="Drawing" style="width: 150px;"/>
1414
</a>
1515

1616

@@ -22,7 +22,7 @@
2222
1. Use your GitHub account token and Gist.
2323
2. Easy to Upload and Download on one click.
2424
3. Show a summary page at the end with details about config and extensions effected.
25-
4. Auto Download Latest Settings on Startup.
25+
4. Auto download Latest Settings on Startup.
2626
5. Auto upload Settings on file change.
2727
6. Share the Gist with other users and let them download your settings.
2828
7. Supports GitHub Enterprise
@@ -36,7 +36,7 @@ All extensions and complete User Folder that Contains
3636
2. Keybinding File
3737
3. Launch File
3838
4. Snippets Folder
39-
5. VSCode Extensions Settings
39+
5. VSCode Extensions & Extensions Configurations
4040
6. Workspaces Folder
4141
```
4242

@@ -46,9 +46,6 @@ All extensions and complete User Folder that Contains
4646
2. Download Key : Shift + Alt + D
4747
```
4848

49-
50-
51-
5249
## Steps To Get a Personal Access Token from GitHub
5350

5451
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
172169

173170
## Settings
174171

172+
There are two types of settings in Settings Sync.
173+
I will recommend you to read the configurations details [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753).
175174

176-
For details regarding settings keys, click [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753)
175+
### Gist Settings
176+
177+
Gist Settings are stored in `settings.json` file of Code.
178+
You can customize the settings in gist settings like:
179+
180+
```
181+
1. Configure Gist Id (Environment)
182+
2. Configure auto upload / download for Github Gist
183+
3. Configure extension sync behaviour
184+
4. Configure force download
185+
5. Configure quiet sync
186+
```
177187

178188
```json
179189
"sync.gist": "0c929b1a6c51015cdc9e0fe2e369ea4c",
180-
"sync.lastUpload": "2018-03-04T14:21:39.841Z",
181190
"sync.autoDownload": false,
182191
"sync.autoUpload": false,
183-
"sync.lastDownload": "2018-03-04T14:21:39.841Z",
184-
"sync.forceDownload": true,
185-
"sync.host": "",
186-
"sync.pathPrefix": "",
192+
"sync.forceDownload": false,
187193
"sync.quietSync": false,
188194
"sync.askGistName": false,
189195
"sync.removeExtensions": true,
190196
"sync.syncExtensions": true
191197
```
192198

193-
## Customized Sync
199+
### Global Settings
200+
201+
Global settings are present in `syncLocalSettings.json` inside `User` folder. These settings will be shared across multiple Gist Environments.
202+
203+
On Windows, this is `%APPDATA%\Code\User\syncLocalSettings.json`.
194204

195-
Extension will create the `syncLocalSettings.json` inside `User` folder upon code start. <br>
196-
On Windows, this is `%APPDATA%\Code\User\syncLocalSettings.json`. <br>
197-
Mac, `$HOME/Library/Application Support/Code/User/syncLocalSettings.json`. <br>
198-
Linux, `~/.config/Code/User/syncLocalSettings.json`. <br>
205+
Mac, `$HOME/Library/Application Support/Code/User/syncLocalSettings.json`.
206+
207+
Linux, `~/.config/Code/User/syncLocalSettings.json`.
199208

200209
You can customize the sync:
201210

202211
```
203212
1. Options by which files / folders and settings to exclude from upload.
204-
2. The Gist Description when creating new Gist.
213+
2. Configure default Gist Environment name.
205214
3. Replace the code settings after downloading.
206215
4. Change the Gist description while creating new one in github.
216+
5. Configure Github Enterprise Url
207217
```
208218

209-
The JSON will be created as:
210-
211219
```json
212220
{
213-
"ignoreUploadFiles": [ "projects.json", "projects_cache_vscode.json",
214-
"projects_cache_git.json", "projects_cache_svn.json", "gpm_projects.json",
221+
"ignoreUploadFiles": [
222+
"projects.json",
223+
"projects_cache_vscode.json",
224+
"projects_cache_git.json",
225+
"projects_cache_svn.json",
226+
"gpm_projects.json",
215227
"gpm-recentItems.json"
216228
],
217229
"ignoreUploadFolders": [
@@ -221,19 +233,25 @@ The JSON will be created as:
221233
"ignored_extension_name"
222234
],
223235
"replaceCodeSettings": {
224-
"http.proxy": "http://my.proxy.address:8080"
236+
"http.proxy": "http://my.proxy.address:8080"
225237
},
226238
"gistDescription": "Visual Studio Code Settings Sync Gist",
227-
"version": 290,
239+
"version": 310,
228240
"token": "YOUR_GITHUB_TOKEN_HERE",
229241
"downloadPublicGist": false,
230242
"supportedFileExtensions": [
231-
"json", "code-snippets"
232-
]
243+
"json",
244+
"code-snippets"
245+
],
246+
"openTokenLink": true,
247+
"useCliBaseInstallation": true,
248+
"lastUpload": null,
249+
"lastDownload": null,
250+
"githubEnterpriseUrl": null
233251
}
234252
```
235253

236-
For settings details, visit my post [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753)
254+
I will recommend you to read the configurations details [here](https://medium.com/@itsShanKhan/visual-studio-code-settings-sync-configurations-ed8dd6fd9753).
237255

238256

239257
## How To Contribute

images/slack.png

13.8 KB
Loading

package.json

Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "code-settings-sync",
33
"displayName": "Settings Sync",
44
"description": "Synchronize Settings, Snippets, Themes, File Icons, Launch, Keybindings, Workspaces and Extensions Across Multiple Machines Using GitHub Gist.",
5-
"version": "3.0.0",
5+
"version": "3.1.0",
66
"icon": "images/cloud.png",
77
"publisher": "Shan",
88
"author": {
@@ -60,12 +60,7 @@
6060
"multi-root ready"
6161
],
6262
"activationEvents": [
63-
"*",
64-
"onCommand:extension.updateSettings",
65-
"onCommand:extension.downloadSettings",
66-
"onCommand:extension.resetSettings",
67-
"onCommand:extension.HowSettings",
68-
"onCommand:extension.otherOptions"
63+
"*"
6964
],
7065
"main": "./out/src/extension",
7166
"contributes": {
@@ -108,16 +103,6 @@
108103
"default": "",
109104
"description": "%ext.config.gist%"
110105
},
111-
"sync.lastUpload": {
112-
"type": "string",
113-
"default": "",
114-
"description": "%ext.config.lastUpload%"
115-
},
116-
"sync.lastDownload": {
117-
"type": "string",
118-
"default": "",
119-
"description": "%ext.config.lastDownload%"
120-
},
121106
"sync.autoDownload": {
122107
"type": "boolean",
123108
"default": false,
@@ -133,16 +118,6 @@
133118
"default": false,
134119
"description": "%ext.config.forceDownload%"
135120
},
136-
"sync.host": {
137-
"type": "string",
138-
"default": "",
139-
"description": "%ext.config.host%"
140-
},
141-
"sync.pathPrefix": {
142-
"type": "string",
143-
"default": "",
144-
"description": "%ext.config.pathPrefix%"
145-
},
146121
"sync.quietSync": {
147122
"type": "boolean",
148123
"default": false,
@@ -168,25 +143,29 @@
168143
}
169144
},
170145
"scripts": {
171-
"vscode:prepublish": "npm run compile",
146+
"vscode:prepublish": "npm run tslint-check && npm run compile",
172147
"compile": "tsc -p ./",
173148
"watch": "tsc -watch -p ./",
174-
"postinstall": "node ./node_modules/vscode/bin/install"
149+
"postinstall": "node ./node_modules/vscode/bin/install",
150+
"tslint-check": "tslint -c ./tslint.json ./src/**/*.ts ./src/*.ts",
151+
"format": "prettier --write './src/**/*.ts'"
175152
},
176153
"devDependencies": {
177-
"typescript": "^2.8.3",
178-
"vscode": "^1.1.6",
179-
"@types/node": "^10.0.3"
154+
"@types/fs-extra": "^5.0.4",
155+
"@types/node": "^10.7.0",
156+
"prettier": "^1.14.2",
157+
"tslint": "^5.11.0",
158+
"tslint-plugin-prettier": "^1.3.0",
159+
"typescript": "^3.0.1",
160+
"vscode": "^1.1.21"
180161
},
181162
"dependencies": {
182-
"adm-zip": "0.4.7",
163+
"@octokit/rest": "^15.10.0",
164+
"adm-zip": "^0.4.11",
183165
"chokidar": "^2.0.2",
184-
"fs": "^0.0.2",
185-
"github": "^11.0.0",
166+
"fs-extra": "^7.0.0",
186167
"https-proxy-agent": "^2.1.1",
187-
"ncp": "^2.0.0",
188-
"proper-lockfile": "^2.0.1",
189-
"rimraf": "^2.6.2",
168+
"lockfile": "^1.0.4",
190169
"temp": "^0.8.3"
191170
}
192171
}

0 commit comments

Comments
 (0)