Skip to content

Commit 32d0598

Browse files
committed
docs: add "what is modified" in FAQ
1 parent db68ab6 commit 32d0598

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,12 @@ To disable all external resources, setup:
181181

182182
## FAQ
183183

184+
### What is modified
185+
186+
ALL modifications are located in VSCode's installation directory, and modified files are backed up with `custom-ui-style` suffix in same directory. See all file paths in [path.ts](https://github.com/subframe7536/vscode-custom-ui-style/tree/main/src/path.ts)
187+
188+
When reload config, the extension will check backup file first, then read content from backup file and overwrite the original file with patches. Finally try to reload window or restart APP.
189+
184190
### No Effect
185191

186192
If you are using Windows or Linux, make sure you have closed all the VSCode windows and then restart.
@@ -209,7 +215,13 @@ See in [#6](https://github.com/subframe7536/vscode-custom-ui-style/issues/6)
209215

210216
### Fail to render panel
211217

212-
According to [#34](https://github.com/subframe7536/vscode-custom-ui-style/issues/34), in Cursor (close source VSCode's fork), the extension detail panel will not show by default due to the violation of iframe's CSP. Currently the way to fix it is just skip patch on webview, so please set `"custom-ui-style.webview.enable": false`
218+
According to [#34](https://github.com/subframe7536/vscode-custom-ui-style/issues/34), in Cursor (close source VSCode's fork), the extension detail panel will not show by default due to the violation of iframe's CSP. Currently the way to fix it is just skip patch on webview, so please set:
219+
220+
```json
221+
{
222+
"custom-ui-style.webview.enable": false
223+
}
224+
```
213225

214226
## Configurations
215227

src/path.ts

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,19 @@ function getWorkbenchPath(baseExt: string, backupExt?: string) {
6868
)
6969
}
7070
/**
71-
* CSS file path
71+
* Workbench CSS file path
7272
*/
7373
export const cssPath = getWorkbenchPath('css')
7474
/**
75-
* CSS file backup path
75+
* Workbench CSS file backup path
7676
*/
7777
export const cssBakPath = getWorkbenchPath('css', bakExt)
7878
/**
79-
* Main js file path
79+
* Workbench main js file path
8080
*/
8181
export const rendererPath = getWorkbenchPath('js')
8282
/**
83-
* Main js file backup path
83+
* Workbench main js file backup path
8484
*/
8585
export const rendererBakPath = getWorkbenchPath('js', bakExt)
8686

@@ -96,7 +96,13 @@ function getMainPath(baseExt: string, backupExt?: string) {
9696
return fs.existsSync(defaultPath) ? defaultPath : path.join(baseDir, `main.${ext}`)
9797
}
9898

99+
/**
100+
* VSCode main js path
101+
*/
99102
export const mainPath = getMainPath('js')
103+
/**
104+
* VSCode main js backup path
105+
*/
100106
export const mainBakPath = getMainPath('js', bakExt)
101107

102108
function getProductJSONPath(baseExt: string, backupExt?: string) {

0 commit comments

Comments
 (0)