feat: add options to disable webview patch (#35)

* add options

* add FAQ

Author: subframe7536

README.md

@@ -15,7 +15,7 @@ VSCode extension that custom ui css style in both editor and webview
 > This extension works by editting the VSCode's css and js files.
 >
 > ~~So, a warning appears while the first time to install or VSCode update. You can click the [never show again] to avoid it.~~
-> From V0.4.0, the warning will no longer prompt after fully restart. #11
+> From V0.4.0, the warning will no longer prompt after fully restart. [#11](https://github.com/subframe7536/vscode-custom-ui-style/issues/11)
 
 ## Features
 
@@ -207,6 +207,10 @@ sudo chown -R $(whoami) "/usr/local/code"
 
 See in [#6](https://github.com/subframe7536/vscode-custom-ui-style/issues/6)
 
+### Fail to render panel
+
+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`
+
 ## Configurations
 
 <!-- configs -->
@@ -227,6 +231,7 @@ See in [#6](https://github.com/subframe7536/vscode-custom-ui-style/issues/6)
 | `custom-ui-style.external.loadStrategy`     | Load strategy for external CSS or JS resources                                                                                                                                                               | `string`  | `"refetch"` |
 | `custom-ui-style.external.imports`          | External CSS or JS resources, support variable: [${userHome}, ${env:your_env_name:optional_fallback_value}], support protocol: 'https://', 'file://'                                                         | `array`   | ``          |
 | `custom-ui-style.stylesheet`                | Custom css for editor, support nest selectors                                                                                                                                                                | `object`  | `{}`        |
+| `custom-ui-style.webview.enable`            | Enable style patch in webview                                                                                                                                                                                | `boolean` | `true`      |
 | `custom-ui-style.webview.monospaceSelector` | Custom monospace selector in webview                                                                                                                                                                         | `array`   | ``          |
 | `custom-ui-style.webview.sansSerifSelector` | Custom sans-serif selector in webview                                                                                                                                                                        | `array`   | ``          |
 | `custom-ui-style.webview.stylesheet`        | Custom css for webview, support nest selectors                                                                                                                                                               | `object`  | `{}`        |

package.json

@@ -170,6 +170,12 @@
           "type": "object",
           "description": "Custom css for editor, support nest selectors"
         },
+        "custom-ui-style.webview.enable": {
+          "scope": "application",
+          "type": "boolean",
+          "default": true,
+          "description": "Enable style patch in webview"
+        },
         "custom-ui-style.webview.monospaceSelector": {
           "scope": "application",
           "type": "array",

src/manager/webview.ts

@@ -43,6 +43,9 @@ export class WebViewFileManager extends BaseFileManager {
   }
 
   patch(content: string): string {
+    if (!config['webview.enable']) {
+      return content
+    }
     return fixSha256(
       content.replace(
         entry,

src/path.ts

@@ -46,12 +46,12 @@ function getWebviewHTML(ext: string) {
     'webview',
     'browser',
     'pre',
-    `index${ext}`,
+    `index.${ext}`,
   )
 }
 
-export const webviewHTMLPath = getWebviewHTML('.html')
-export const webviewHTMLBakPath = getWebviewHTML(`.${bakExt}.html`)
+export const webviewHTMLPath = getWebviewHTML('html')
+export const webviewHTMLBakPath = getWebviewHTML(`${bakExt}.html`)
 /**
  * See https://code.visualstudio.com/api/references/vscode-api#env
  */