WIP : #258 #666

tkrtmy · 2018-10-04T04:57:24Z

This is proposal.

Customized sync problem is each machine's path difference.
So be able to set up download path at each machine.

and resolve ↓ issue.
#258

Scenario

1. Add additionaly sync files.

syncLocalSettings.json

{
 ...
  "customFiles": {
    ".eslint": "/Users/tkrtmy/.eslint" // download  path. if is not set it, is not downloaded it.
  },
 ...
}

append |customized_sync| prefix to file's name at gist for identifiyng
ex. .eslint => |customized_sync|.eslint

2. upload or download them.

tkrtmy · 2018-10-04T04:58:14Z

src/service/fileService.ts

@@ -193,4 +195,43 @@ export class FileService {
      throw err;
    }
  }
+


add some util methods

tkrtmy · 2018-10-04T04:58:48Z

src/sync.ts

@@ -188,6 +188,18 @@ export class Sync {
            return matchedFolders.length > 0;
          });
        }
+        const customFileKeys: string[] = Object.keys(


upload additional files

tkrtmy · 2018-10-04T04:59:06Z

src/sync.ts

@@ -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;


download additional files

tkrtmy · 2018-10-04T05:00:23Z

src/sync.ts

+              const fileName = gistName.split(prefix).join(""); // |customized_sync|.htmlhintrc => .htmlhintrc
+              if (!(fileName in customSettings.customFiles)) {
+                // syncLocalSettings.json > customFiles doesn't have key
+                return;


skip download if does not set download path.

tkrtmy · 2018-10-04T05:00:57Z

src/sync.ts

@@ -699,6 +730,7 @@ export class Sync {
      "cmd.otherOptions.toggleAutoDownload",
      "cmd.otherOptions.toggleSummaryPage",
      "cmd.otherOptions.preserve",
+      "cmd.otherOptions.customizedSync",


create new advanced option

shanalikhan · 2018-10-06T15:14:23Z

There should be two options

Sync : Upload Custom File
Sync : Download Custom File

Uploading the custom file is the same you have done so far.

Download custom file when selected The menu should be opened to select the custom files available in the GIST.
Upon selecting the file name it should download the file into root directory of the opened workspace/project.

In this way usr can have multiple files to upload from multiple computers in single GIST
But only download or import the selected file into the current workspace

tkrtmy · 2018-10-07T11:37:52Z

@shanalikhan Thank you for your review.
I understood that Download custom file option is required.
So I'll add Sync: Import Custom File to workspace (download in root dir of the workspace) in Advanced Options.
Did I get the right?

tkrtmy · 2018-10-07T13:48:12Z

Added download custom file option.

select customized file to download from gist.

tkrtmy · 2018-10-07T13:50:25Z

src/sync.ts

+          }
+        }
+      },
+      9: async () => {


download customized file from gist option

tkrtmy · 2018-10-07T14:34:53Z

screenshot of final draft.

shanalikhan · 2018-10-07T15:55:45Z

Thanks for your work.
Meanwhile, i will be doing a code review, can you write the test using mocha also for this feature.

protiumx · 2018-10-08T06:52:31Z

@tkrtmy I added tests in the PR #667. I used mocha & chai. To avoid conflicts, @shanalikhan could you define a folder structure for tests? As reference test folder in PR

shanalikhan · 2018-10-08T08:42:13Z

I have defined the test folder in this branch with index.ts default file.
You can write tests over there.

tkrtmy · 2018-10-08T08:55:41Z

@ioprotium I think that I should use this.
vscode/lib/testrunner use mocha.
How about it?

for example directory

test
├── index.ts
├── extension.test.ts
└── service
    └── fileService.test.ts

index.ts like this.

import * as testRunner from "vscode/lib/testrunner";

testRunner.configure({
  ui: "bdd",
  useColors: true,
  timeout: 5000
});

module.exports = testRunner;

@shanalikhan Sorry, In my PR. New feature is monolithically built in sync.ts, not as module. so I can add small test.
I can't write sync.ts's test because of time constrains. 😭

shanalikhan · 2018-10-08T09:55:31Z

so I can add small test.

No problem, you can write whatever test you like regarding above feature 😄

Public Wiki edit is enabled. Feel free to create new page with your work explained.

shanalikhan · 2018-10-09T09:22:59Z

@tkrtmy
I have merged this Pull Request if i will highly appreciate if you can write the Test Cases for this feature.

I will publish new version in a week or two.

tkrtmy · 2018-10-11T07:31:24Z

@shanalikhan
I edit this wiki.

And wrote small Test Cases regarding this feature.
#671

shanalikhan · 2018-10-11T08:35:43Z

Thanks, Merged!
Will, you be able to solve the issues for this feature, if we get any after publishing. ?

tkrtmy · 2018-10-15T04:44:42Z

You're welcome.
Please any issue related with this feature will be assign to me.

tkrtmy added 3 commits October 4, 2018 13:08

be able to upload additional file

ceb955d

be able to download additional files

601c1e8

create new advanced setting to add Customized Sync file

7fa4345

IssueHuntBot mentioned this pull request Oct 4, 2018

Idea/Suggestion: Adds support to sync custom files #258

Closed

tkrtmy commented Oct 4, 2018

View reviewed changes

src/service/fileService.ts

@@ -193,4 +195,43 @@ export class FileService {

throw err;

}

}

Copy link

Author

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add some util methods

tkrtmy commented Oct 4, 2018

View reviewed changes

shanalikhan changed the title ~~Customized Sync~~ WIP : #258 Oct 6, 2018

tkrtmy added 2 commits October 7, 2018 22:38

fix typo eslint => eslintrc

1413137

Add Import Custom File to workspace option

84c12f4

tkrtmy commented Oct 7, 2018

View reviewed changes

src/sync.ts

}

}

},

9: async () => {

Copy link

Author

tkrtmy Oct 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

download customized file from gist option

unify display message: Custom Sync File

699e87d

Merge branch 'v3.2' into customized-sync

945b03f

shanalikhan added this to the v3.2 milestone Oct 9, 2018

shanalikhan added the feature-request 💡 label Oct 9, 2018

shanalikhan merged commit 9e287f8 into shanalikhan:v3.2 Oct 9, 2018

tkrtmy mentioned this pull request Oct 11, 2018

add fileService.test.ts #671

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP : #258 #666

WIP : #258 #666

tkrtmy commented Oct 4, 2018

tkrtmy Oct 4, 2018

tkrtmy Oct 4, 2018

tkrtmy Oct 4, 2018

tkrtmy Oct 4, 2018

tkrtmy Oct 4, 2018

shanalikhan commented Oct 6, 2018

tkrtmy commented Oct 7, 2018

tkrtmy commented Oct 7, 2018

tkrtmy Oct 7, 2018

tkrtmy commented Oct 7, 2018

shanalikhan commented Oct 7, 2018

protiumx commented Oct 8, 2018

shanalikhan commented Oct 8, 2018

tkrtmy commented Oct 8, 2018

shanalikhan commented Oct 8, 2018 •

edited

Loading

shanalikhan commented Oct 9, 2018

tkrtmy commented Oct 11, 2018

shanalikhan commented Oct 11, 2018 •

edited

Loading

tkrtmy commented Oct 15, 2018

WIP : #258 #666

WIP : #258 #666

Conversation

tkrtmy commented Oct 4, 2018

This is proposal.

1. Add additionaly sync files.

2. upload or download them.

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

tkrtmy Oct 4, 2018

Choose a reason for hiding this comment

shanalikhan commented Oct 6, 2018

tkrtmy commented Oct 7, 2018

tkrtmy commented Oct 7, 2018

tkrtmy Oct 7, 2018

Choose a reason for hiding this comment

tkrtmy commented Oct 7, 2018

shanalikhan commented Oct 7, 2018

protiumx commented Oct 8, 2018

shanalikhan commented Oct 8, 2018

tkrtmy commented Oct 8, 2018

shanalikhan commented Oct 8, 2018 • edited Loading

shanalikhan commented Oct 9, 2018

tkrtmy commented Oct 11, 2018

shanalikhan commented Oct 11, 2018 • edited Loading

tkrtmy commented Oct 15, 2018

shanalikhan commented Oct 8, 2018 •

edited

Loading

shanalikhan commented Oct 11, 2018 •

edited

Loading