release 3.0.0

Author: nonoroazoro

.eslintrc

@@ -0,0 +1,12 @@
+{
+    "extends": [
+        "eslint-config-zoro/eslint",
+        "eslint-config-zoro/typescript"
+    ],
+    "env": {
+        "jest": true
+    },
+    "parserOptions": {
+        "project": "./tsconfig.json"
+    }
+}

.gitignore

@@ -1,9 +1,9 @@
 # Node files
 node_modules
-package-lock.json
 
 # OS junk files
 .DS_Store
 
 # Project specific stuff
+.cache-loader
 dist

.lintstagedrc

@@ -0,0 +1,6 @@
+{
+    "{src,tests}/**/*.{js,ts,tsx}": [
+        "eslint",
+        "git add"
+    ]
+}

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
 	"recommendations": [
-		"ms-vscode.vscode-typescript-tslint-plugin"
+		"dbaeumer.vscode-eslint"
 	],
 	"unwantedRecommendations": []
 }

.vscode/launch.json

@@ -18,7 +18,7 @@
             "smartStep": true,
             "sourceMaps": true,
             "osx": {
-                // "preLaunchTask": "tsc-watch"
+                "preLaunchTask": "tsc-watch"
             },
         }
     ]

.vscode/settings.json

@@ -1,4 +1,19 @@
 {
+    "eslint.validate": [
+        "javascript",
+        "javascriptreact",
+        {
+            "language": "typescript",
+            "autoFix": true
+        },
+        {
+            "language": "typescriptreact",
+            "autoFix": true
+        }
+    ],
+    "files.exclude": {
+        "**/.cache-loader": true
+    },
     "search.exclude": {
         "**/dist": true,
         "**/yarn.lock": true

.vscodeignore

@@ -15,6 +15,7 @@ tslint.json
 webpack.config.prod.js
 
 # Project specific stuff
+__tests__/**
 .github/**
 docs/**
 src/**

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelogs
 
+## 3.0.0 - May 10, 2019
+
+- Added: Add support for settings **auto-sync**.
+
+
 ## 2.1.6 - April 04, 2019
 
 - Changed: Remove unused files to reduce the extension size and improve the performance.
@@ -9,7 +14,7 @@
 
 - Added: Handle error during initialization.
 
-- Added: Added Anti 996 license.
+- Added: Add Anti 996 license.
 
 - Changed: Tweak localizations.
 
@@ -58,19 +63,19 @@
 
 ## 2.0.6 - November 29, 2018
 
-- Fixed: Fixed the [issue](https://github.com/octokit/rest.js/issues/1144) introduced by `deepmerge`.
+- Fixed: Fix the [issue](https://github.com/octokit/rest.js/issues/1144) introduced by `deepmerge`.
 
 
 ## 2.0.5 - November 29, 2018
 
-- Changed: Replaced `moment` with `date-fns` which can significantly reduce the extension's size.
+- Changed: Replace `moment` with `date-fns` which can significantly reduce the extension's size.
 
-- Fixed: Fixed the [event-stream security issue](https://code.visualstudio.com/blogs/2018/11/26/event-stream).
+- Fixed: Fix the [event-stream security issue](https://code.visualstudio.com/blogs/2018/11/26/event-stream).
 
 
 ## 2.0.2 - November 13, 2018
 
-- Fixed: Fixed an error while parsing VSCode settings.
+- Fixed: Fix an error while parsing VSCode settings.
 
 
 ## 2.0.1 - November 01, 2018

README.md

@@ -18,23 +18,23 @@
 
 ## Breaking Changes
 
-* From ***version 2.1.2*** onwards:
+* From ***version 3.0.0*** onwards:
 
-    1. Increase the download speed and accelerate the process of adding and installing VSCode extensions.
+    1. Supports **auto-sync** (finally...), here's a brief guide:
 
-    1. Add support for different editions of VSCode binaries as the followings:
+        1. ***Disclaimer***, by enabling auto-sync, you may **unintentionally overwrite** your settings ([see the discussion here](https://github.com/nonoroazoro/vscode-syncing/issues/6)), make sure you know what you're doing before you continue!
 
-        1. [VSCode Standard Builds](https://code.visualstudio.com/).
+        1. It's **highly recommended** that you perform a `Download Settings` (which will set a baseline) before the following steps.
 
-        1. [VSCode Insiders Builds](https://code.visualstudio.com/insiders/).
+        1. `Open Syncing Settings` ([Don't known how to open?](#auto-sync-settings)) and enable the **auto-sync** like the followings:
 
-        1. [VSCode Exploration Builds](https://github.com/Microsoft/vscode/issues/61787).
+            ```json
+            "auto_sync": true
+            ```
 
-        1. VSCode builds under FLOSS license, see [VSCodium](https://github.com/VSCodium/vscodium).
+        1. Reload or reopen your VSCode and enjoy!
 
-        1. Self-compiled VSCode under [the default configuration](https://github.com/Microsoft/vscode/blob/master/product.json) (Thank [@Backfighter](https://github.com/Backfighter) for the PR).
-
-        > Don't worry, Syncing will automatically identify the VSCode edition for you.
+        > BTW, don't forget to fill in the correct `Github Personal Access Token` and `Gist ID`, otherwise auto-sync will not work.
 
 
 ## Features
@@ -188,6 +188,21 @@ Moreover, if the `"http_proxy"` is unset, `Syncing` will try to read the `http_p
 > Please note that unlike the settings in [VSCode User Settings](#vscode-user-settings), `Syncing` **will not upload** its own settings file because it contains your personal information.
 
 
+## Auto-sync Settings
+
+You can now let Syncing auto-sync your settings. Here are the steps:
+
+1. Type `"Syncing: Open Syncing Settings"` (or just `"opensync"`) in `VSCode Command Palette` to open `Syncing`'s own settings file (i.e. `syncing.json`).
+
+1. Enable the `"auto_sync"` setting, for example:
+
+    ```json
+    "auto_sync": "auto"
+    ```
+
+1. Reload or reopen VSCode to take effect.
+
+
 ## Getting Started
 
 1. Get your own `GitHub Personal Access Token` (3 steps).

README.zh-CN.md

@@ -18,23 +18,23 @@
 
 ## 重要变更
 
-* 从 ***2.1.2*** 版本开始：
+* 从 ***3.0.0*** 版本开始：
 
-    1. 显著加快 VSCode 插件的下载和安装速度，尤其是中国用户在无代理情况下的下载和安装速度；
+    1. 支持**配置自动同步**（终于...），以下是简单步骤：
 
-    1. 增加对各种 VSCode 版本的支持，包括：
+        1. ***免责声明***：启用自动同步后，在某些情况下可能会导致您错误地覆盖配置文件（[参考这里的讨论](https://github.com/nonoroazoro/vscode-syncing/issues/6)），因此在继续之前，请务必确认您是否真的需要启用该功能；
 
-        1. [VSCode 标准版本](https://code.visualstudio.com/)；
+        1. 在后续操作之前，**强烈推荐**您执行一次`下载配置`以便让自动同步功能更好地工作；
 
-        1. [VSCode Insiders 版本](https://code.visualstudio.com/insiders/)；
+        1. 打开 `Syncing` 的配置文件（[不知道如何打开？](#配置自动同步)）并启用 **auto-sync**，例如：
 
-        1. [VSCode Exploration 版本](https://github.com/Microsoft/vscode/issues/61787)；
+            ```json
+            "auto_sync": true
+            ```
 
-        1. [VSCodium](https://github.com/VSCodium/vscodium)，这是 [FLOSS License](https://www.gnu.org/philosophy/floss-and-foss.en.html) 下的一个 VSCode 版本；
+        1. 重新加载或重启 VSCode，大功告成！
 
-        1. 按照[默认配置](https://github.com/Microsoft/vscode/blob/master/product.json)自行编译的 VSCode 版本 (感谢 [@Backfighter](https://github.com/Backfighter) 的 PR)。
-
-        > 无须担心，升级之后 Syncing 会自动帮您检测 VSCode 版本。
+        > 最后，别忘了设置您的 `Github Personal Access Token` 和 `Gist ID`，否则自动同步功能将不会工作。
 
 
 ## 功能
@@ -188,6 +188,21 @@
 > 注意：不同于那些保存在 [VSCode 用户设置](#vscode-配置项)中的 `Syncing` 配置项，这个独立的配置文件并**不会被同步**，因为里面保存了您的私人信息。
 
 
+## 配置自动同步
+
+Syncing 现在支持配置自动同步了，具体步骤如下：
+
+1. 在 `VSCode 的命令面板`中输入 `Syncing: Open Syncing Settings`（或者 `opensync`）来打开 `Syncing` 自己的配置文件（即 `syncing.json` 文件）；
+
+1. 启用 `"auto_sync"` 配置，例如：
+
+    ```json
+    "auto_sync": "auto"
+    ```
+
+1. 重新加载或重启 VSCode。
+
+
 ## 快速开始
 
 1. 创建您自己的 `GitHub Personal Access Token`（总共 3 步）：