WIP : #258

package.nls.ja.json

@@ -54,6 +54,13 @@
   "cmd.otherOptions.preserve.prompt": "例 : 'http.proxy' => このコンピュータのプロキシを保存して, それで上書きします. 空の場合プロキシを削除します.",
   "cmd.otherOptions.preserve.info.done1": "Sync : 終了します. {0} の値はダウンロード後 settings.json から削除されます.",
   "cmd.otherOptions.preserve.info.done2": "Sync : 終了します. ダウンロード後に {0} : {1} で settings.json に保持します.",
+  "cmd.otherOptions.customizedSync": "Sync: カスタム同期",
+  "cmd.otherOptions.customizedSync.placeholder": "追加でアップロードするファイルの絶対パスを入力してください.",
+  "cmd.otherOptions.customizedSync.prompt": "(ex. /path/to/.eslintrc) はアップロードされ, 指定したパスにダウンロードされます.",
+  "cmd.otherOptions.customizedSync.done": "Sync : {0} を登録しました.",
+  "cmd.otherOptions.downloadCustomFile": "Sync: カスタムファイルのインポート",
+  "cmd.otherOptions.downloadCustomFile.placeholder": "作業中のworkspaceのルートディレクトリにダウンロードするファイルを選択してください.",
+  "cmd.otherOptions.downloadCustomFile.done": "{0} にダウンロードしました.",
   "cmd.otherOptions.joinCommunity": "Sync : コミュニティに参加する",
   "cmd.otherOptions.openIssue": "Sync : Issue を作成する",
   "cmd.otherOptions.releaseNotes": "Sync : リリースノート",

package.nls.json

@@ -54,6 +54,13 @@
   "cmd.otherOptions.preserve.prompt": "Example : Write 'http.proxy' => store this computer proxy and overwrite it , if set empty it will remove proxy.",
   "cmd.otherOptions.preserve.info.done1": "Sync : Done. {0} value will be removed from settings.json after downloading.",
   "cmd.otherOptions.preserve.info.done2": "Sync : Done. Extension will keep {0} : {1} in setting.json after downloading.",
+  "cmd.otherOptions.customizedSync": "Sync: Customized Sync",
+  "cmd.otherOptions.customizedSync.placeholder": "Enter an absolute path of the additional uploaded file.",
+  "cmd.otherOptions.customizedSync.prompt": "(ex. /path/to/.eslintrc) will be uploaded and downloaded to the specified path.",
+  "cmd.otherOptions.customizedSync.done": "Sync : {0} has been registered.",
+  "cmd.otherOptions.downloadCustomFile": "Sync: Import Custom File to workspace",
+  "cmd.otherOptions.downloadCustomFile.placeholder": "Select the file you want to download to the root of the workspace you are working on.",
+  "cmd.otherOptions.downloadCustomFile.done": "Downloaded {0}.",
   "cmd.otherOptions.joinCommunity": "Sync : Join Community",
   "cmd.otherOptions.openIssue": "Sync : Open Issue",
   "cmd.otherOptions.releaseNotes": "Sync : Release Notes",

src/service/fileService.ts

@@ -12,6 +12,8 @@ export class File {
   ) {}
 }
 export class FileService {
+  public static CUSTOMIZED_SYNC_PREFIX = "|customized_sync|";
+
   public static async ReadFile(filePath: string): Promise<string> {
     try {
       const data = await fs.readFile(filePath, { encoding: "utf8" });
@@ -193,4 +195,47 @@ export class FileService {
       throw err;
     }
   }
+
+  public static async GetCustomFile(
+    filePath: string,
+    fileName: string
+  ): Promise<File> {
+    const fileExists: boolean = await FileService.FileExists(filePath);
+
+    if (!fileExists) {
+      return null;
+    }
+
+    const content = await FileService.ReadFile(filePath);
+
+    if (content === null) {
+      return null;
+    }
+
+    // for identifing Customized Sync file
+    const gistName: string = FileService.CUSTOMIZED_SYNC_PREFIX + fileName;
+
+    const file: File = new File(fileName, content, filePath, gistName);
+    return file;
+  }
+
+  public static async CreateCustomDirTree(filePath: string): Promise<string> {
+    const dir = path.dirname(filePath);
+    const fileExists = await FileService.FileExists(dir);
+
+    if (!fileExists) {
+      // mkdir recursively
+      await fs.mkdirs(dir);
+    }
+
+    return filePath;
+  }
+
+  public static ExtractFileName(fullPath: string): string {
+    return path.basename(fullPath);
+  }
+
+  public static ConcatPath(...filePaths: string[]): string {
+    return filePaths.join(path.sep);
+  }
 }

src/setting.ts

@@ -52,4 +52,5 @@ export class CustomSettings {
   public lastDownload: Date = null;
   public githubEnterpriseUrl: string = null;
   public askGistName: boolean = false;
+  public customFiles: { [key: string]: string } = {};
 }

src/sync.ts

@@ -188,6 +188,18 @@ export class Sync {
             return matchedFolders.length > 0;
           });
         }
+        const customFileKeys: string[] = Object.keys(
+          customSettings.customFiles
+        );
+        if (customFileKeys.length > 0) {
+          for (const key of customFileKeys) {
+            const val = customSettings.customFiles[key];
+            const customFile: File = await FileService.GetCustomFile(val, key);
+            if (customFile !== null) {
+              allSettingFiles.push(customFile);
+            }
+          }
+        }
       } else {
         Commons.LogException(null, common.ERROR_MESSAGE, true);
         return;
@@ -437,7 +449,21 @@ export class Sync {
       keys.forEach(gistName => {
         if (res.data.files[gistName]) {
           if (res.data.files[gistName].content) {
-            if (gistName.indexOf(".") > -1) {
+            const prefix = FileService.CUSTOMIZED_SYNC_PREFIX;
+            if (gistName.indexOf(prefix) > -1) {
+              const fileName = gistName.split(prefix).join(""); // |customized_sync|.htmlhintrc => .htmlhintrc
+              if (!(fileName in customSettings.customFiles)) {
+                // syncLocalSettings.json > customFiles doesn't have key
+                return;
+              }
+              const f: File = new File(
+                fileName,
+                res.data.files[gistName].content,
+                customSettings.customFiles[fileName],
+                gistName
+              );
+              updatedFiles.push(f);
+            } else if (gistName.indexOf(".") > -1) {
               if (
                 env.OsType === OsType.Mac &&
                 gistName === env.FILE_KEYBINDING_DEFAULT
@@ -559,10 +585,15 @@ export class Sync {
               if (file.gistName === env.FILE_KEYBINDING_MAC) {
                 file.fileName = env.FILE_KEYBINDING_DEFAULT;
               }
-              const filePath: string = await FileService.CreateDirTree(
-                env.USER_FOLDER,
-                file.fileName
-              );
+              let filePath: string = "";
+              if (file.filePath !== null) {
+                filePath = await FileService.CreateCustomDirTree(file.filePath);
+              } else {
+                filePath = await FileService.CreateDirTree(
+                  env.USER_FOLDER,
+                  file.fileName
+                );
+              }
 
               actionList.push(
                 FileService.WriteFile(filePath, content)
@@ -699,6 +730,8 @@ export class Sync {
       "cmd.otherOptions.toggleAutoDownload",
       "cmd.otherOptions.toggleSummaryPage",
       "cmd.otherOptions.preserve",
+      "cmd.otherOptions.customizedSync",
+      "cmd.otherOptions.downloadCustomFile",
       "cmd.otherOptions.joinCommunity",
       "cmd.otherOptions.openIssue",
       "cmd.otherOptions.releaseNotes"
@@ -817,22 +850,89 @@ export class Sync {
         }
       },
       8: async () => {
+        // add customized sync file
+        const options: vscode.InputBoxOptions = {
+          ignoreFocusOut: true,
+          placeHolder: localize("cmd.otherOptions.customizedSync.placeholder"),
+          prompt: localize("cmd.otherOptions.customizedSync.prompt")
+        };
+        const input = await vscode.window.showInputBox(options);
+
+        if (input) {
+          const fileName: string = FileService.ExtractFileName(input);
+          if (fileName === "") {
+            return;
+          }
+          customSettings.customFiles[fileName] = input;
+          const done: boolean = await common.SetCustomSettings(customSettings);
+          if (done) {
+            vscode.window.showInformationMessage(
+              localize("cmd.otherOptions.customizedSync.done", fileName)
+            );
+          }
+        }
+      },
+      9: async () => {
+        // Import customized sync file to workspace
+        const customFiles = await this.getCustomFilesFromGist(
+          customSettings,
+          setting
+        );
+        if (customFiles.length < 1) {
+          return;
+        }
+        const options: vscode.QuickPickOptions = {
+          ignoreFocusOut: true,
+          placeHolder: localize(
+            "cmd.otherOptions.downloadCustomFile.placeholder"
+          )
+        };
+        const fileName = await vscode.window.showQuickPick(
+          customFiles.map(file => {
+            return file.fileName;
+          }),
+          options
+        );
+        // if not pick anyone, do nothing
+        if (!fileName) {
+          return;
+        }
+        const selected = customFiles.find(f => {
+          return f.fileName === fileName;
+        });
+        if (selected && vscode.workspace.rootPath) {
+          const downloadPath = FileService.ConcatPath(
+            vscode.workspace.rootPath,
+            selected.fileName
+          );
+          const done = await FileService.WriteFile(
+            downloadPath,
+            selected.content
+          );
+          if (done) {
+            vscode.window.showInformationMessage(
+              localize("cmd.otherOptions.downloadCustomFile.done", downloadPath)
+            );
+          }
+        }
+      },
+      10: async () => {
         vscode.commands.executeCommand(
           "vscode.open",
           vscode.Uri.parse(
             "https://join.slack.com/t/codesettingssync/shared_invite/enQtMzE3MjY5NTczNDMwLTYwMTIwNGExOGE2MTJkZWU0OTU5MmI3ZTc4N2JkZjhjMzY1OTk5OGExZjkwMDMzMDU4ZTBlYjk5MGQwZmMyNzk"
           )
         );
       },
-      9: async () => {
+      11: async () => {
         vscode.commands.executeCommand(
           "vscode.open",
           vscode.Uri.parse(
             "https://github.com/shanalikhan/code-settings-sync/issues/new"
           )
         );
       },
-      10: async () => {
+      12: async () => {
         vscode.commands.executeCommand(
           "vscode.open",
           vscode.Uri.parse(
@@ -920,4 +1020,41 @@ export class Sync {
       return;
     }
   }
+
+  private async getCustomFilesFromGist(
+    customSettings: CustomSettings,
+    syncSetting: ExtensionConfig
+  ): Promise<File[]> {
+    const github = new GitHubService(
+      customSettings.token,
+      customSettings.githubEnterpriseUrl
+    );
+    const res = await github.ReadGist(syncSetting.gist);
+    if (!res) {
+      Commons.LogException(res, "Sync : Unable to Read Gist.", true);
+      return [];
+    }
+    const keys = Object.keys(res.data.files);
+    const customFiles: File[] = [];
+    keys.forEach(gistName => {
+      if (res.data.files[gistName]) {
+        if (res.data.files[gistName].content) {
+          const prefix = FileService.CUSTOMIZED_SYNC_PREFIX;
+          if (gistName.indexOf(prefix) > -1) {
+            const fileName = gistName.split(prefix).join(""); // |customized_sync|.htmlhintrc => .htmlhintrc
+            const f: File = new File(
+              fileName,
+              res.data.files[gistName].content,
+              fileName in customSettings.customFiles
+                ? customSettings.customFiles[fileName]
+                : null,
+              gistName
+            );
+            customFiles.push(f);
+          }
+        }
+      }
+    });
+    return customFiles;
+  }
 }