Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#747 add preview.style directory as a local resource roots in the WebView #828

Merged
merged 1 commit into from
Nov 25, 2023
Merged

#747 add preview.style directory as a local resource roots in the WebView #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions src/asciidoctorWebViewConverter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,8 +419,13 @@ ${node.hasAttribute('manpurpose') ? this.generateManNameSection(node) : ''}`
return this.webviewResourceProvider.asMediaWebViewSrc('dist', mediaFile)
}

private getStyles (node: Asciidoctor.Document, webviewResourceProvider: WebviewResourceProvider, resource: vscode.Uri,
config: AsciidocPreviewConfiguration, state?: any): string {
private getStyles (
node: Asciidoctor.Document,
webviewResourceProvider: WebviewResourceProvider,
textDocumentUri: vscode.Uri,
config: AsciidocPreviewConfiguration,
state?: any
): string {
const baseStyles: string[] = []
for (const previewStyle of this.contributions.previewStyles) {
baseStyles.push(`<link rel="stylesheet" type="text/css" href="${escapeAttribute(webviewResourceProvider.asWebviewUri(previewStyle))}">`)
Expand All @@ -434,7 +439,7 @@ ${node.hasAttribute('manpurpose') ? this.generateManNameSection(node) : ''}`
baseStyles.push(`<link rel="stylesheet" href="${webviewResourceProvider.asMediaWebViewSrc('media', 'font-awesome', 'css', 'font-awesome.css')}">`)
}
return `${baseStyles.join('\n')}
${this.computeCustomStyleSheetIncludes(webviewResourceProvider, resource, config)}
${this.computeCustomStyleSheetIncludes(webviewResourceProvider, textDocumentUri, config)}
${this.getImageStabilizerStyles(state)}`
}

Expand All @@ -446,13 +451,13 @@ ${node.hasAttribute('manpurpose') ? this.generateManNameSection(node) : ''}`
return out.join('\n')
}

private computeCustomStyleSheetIncludes (webviewResourceProvider: WebviewResourceProvider, resource: vscode.Uri, config: AsciidocPreviewConfiguration): string {
const style = config.previewStyle
if (style === '') {
private computeCustomStyleSheetIncludes (webviewResourceProvider: WebviewResourceProvider, textDocumentUri: vscode.Uri, config: AsciidocPreviewConfiguration): string {
const stylePath = config.previewStyle
if (stylePath === '') {
return ''
}
const out: string[] = []
out.push(`<link rel="stylesheet" class="code-user-style" data-source="${escapeAttribute(style)}" href="${escapeAttribute(this.fixHref(webviewResourceProvider, resource, style))}" type="text/css" media="screen">`)
out.push(`<link rel="stylesheet" class="code-user-style" data-source="${escapeAttribute(stylePath)}" href="${escapeAttribute(this.fixHref(webviewResourceProvider, textDocumentUri, stylePath))}" type="text/css" media="screen">`)
return out.join('\n')
}

Expand All @@ -471,7 +476,7 @@ ${node.hasAttribute('manpurpose') ? this.generateManNameSection(node) : ''}`
return ret
}

private fixHref (webviewResourceProvider: WebviewResourceProvider, resource: vscode.Uri, href: string): string {
private fixHref (webviewResourceProvider: WebviewResourceProvider, textDocumentUri: vscode.Uri, href: string): string {
// QUESTION: should we use `stylesdir` attribute in here?
if (!href) {
return href
Expand All @@ -487,12 +492,12 @@ ${node.hasAttribute('manpurpose') ? this.generateManNameSection(node) : ''}`
}

// Use a workspace relative path if there is a workspace
const root = getWorkspaceFolder(resource)
const root = getWorkspaceFolder(textDocumentUri)
if (root) {
return webviewResourceProvider.asWebviewUri(vscode.Uri.joinPath(root.uri, href)).toString()
}

// Otherwise look relative to the AsciiDoc file
return webviewResourceProvider.asWebviewUri(vscode.Uri.joinPath(uri.Utils.dirname(resource), href)).toString()
return webviewResourceProvider.asWebviewUri(vscode.Uri.joinPath(uri.Utils.dirname(textDocumentUri), href)).toString()
}
}
32 changes: 21 additions & 11 deletions src/features/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { AsciidocContentProvider } from './previewContentProvider'
import { disposeAll, Disposable } from '../util/dispose'
import { WebviewResourceProvider } from '../util/resources'
import { AsciidocFileTopmostLineMonitor, getVisibleLine } from '../util/topmostLineMonitor'
import { AsciidocPreviewConfigurationManager } from './previewConfig'
import { AsciidocPreviewConfiguration, AsciidocPreviewConfigurationManager } from './previewConfig'
import { AsciidocContributionProvider } from '../asciidocExtensions'
import { isAsciidocFile } from '../util/file'
import { resolveLinkToAsciidocFile } from '../commands/openDocumentLink'
Expand Down Expand Up @@ -63,7 +63,7 @@ export class AsciidocPreview extends Disposable implements WebviewResourceProvid
topmostLineMonitor,
contributionProvider)

preview.editor.webview.options = AsciidocPreview.getWebviewOptions(resource, contributionProvider)
preview.editor.webview.options = AsciidocPreview.getWebviewOptions(resource, contributionProvider, previewConfigurations.loadAndCacheConfiguration(resource))

if (!isNaN(line)) {
preview.line = line
Expand Down Expand Up @@ -94,7 +94,7 @@ export class AsciidocPreview extends Disposable implements WebviewResourceProvid
{
enableFindWidget: true,
retainContextWhenHidden,
...AsciidocPreview.getWebviewOptions(resource, contributionProvider),
...AsciidocPreview.getWebviewOptions(resource, contributionProvider, previewConfigurations.loadAndCacheConfiguration(resource)),
}
)

Expand Down Expand Up @@ -376,27 +376,37 @@ export class AsciidocPreview extends Disposable implements WebviewResourceProvid
this.editor.title = AsciidocPreview.getPreviewTitle(this._resource, this._locked)
}
this.editor.iconPath = this.iconPath
this.editor.webview.options = AsciidocPreview.getWebviewOptions(resource, this._contributionProvider)
const content = await this._contentProvider.providePreviewHTML(document, this._previewConfigurations, this, this.line)
this.editor.webview.html = content
const asciidocPreviewConfiguration = this._previewConfigurations.loadAndCacheConfiguration(resource)
this.editor.webview.options = AsciidocPreview.getWebviewOptions(resource, this._contributionProvider, asciidocPreviewConfiguration)
this.editor.webview.html = await this._contentProvider.providePreviewHTML(document, this._previewConfigurations, this, this.line)
}

private static getWebviewOptions (
resource: vscode.Uri,
contributionProvider: AsciidocContributionProvider
contributionProvider: AsciidocContributionProvider,
asciidocPreviewConfiguration: AsciidocPreviewConfiguration
): vscode.WebviewOptions {
return {
enableScripts: true,
enableCommandUris: true,
localResourceRoots: AsciidocPreview.getLocalResourceRoots(resource, contributionProvider),
localResourceRoots: AsciidocPreview.getLocalResourceRoots(resource, contributionProvider, asciidocPreviewConfiguration),
}
}

private static getLocalResourceRoots (resource: vscode.Uri, contributionProviderr: AsciidocContributionProvider): vscode.Uri[] {
private static getLocalResourceRoots (
resource: vscode.Uri,
contributionProvider: AsciidocContributionProvider,
asciidocPreviewConfiguration: AsciidocPreviewConfiguration
): vscode.Uri[] {
const baseRoots: vscode.Uri[] = [
vscode.Uri.joinPath(contributionProviderr.extensionUri, 'media'),
vscode.Uri.joinPath(contributionProviderr.extensionUri, 'dist'),
vscode.Uri.joinPath(contributionProvider.extensionUri, 'media'),
vscode.Uri.joinPath(contributionProvider.extensionUri, 'dist'),
]
const previewStylePath = asciidocPreviewConfiguration.previewStyle
if (previewStylePath !== '') {
const previewStyleUri = vscode.Uri.parse(previewStylePath)
baseRoots.push(uri.Utils.dirname(previewStyleUri))
}
const folder = getWorkspaceFolder(resource)
if (folder) {
const workspaceRoots = getWorkspaceFolders()?.map((folder) => folder.uri)
Expand Down