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.

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

Implement option for initial indent in non-template regions #1822

Merged
merged 4 commits into from Sep 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 49 additions & 0 deletions extensions/vscode-vue-language-features/package.json
Expand Up @@ -370,6 +370,55 @@
"default": false,
"description": "Auto-complete Ref value with `.value`."
},
"volar.initialIndent": {
"type": "object",
"description": "Whether to have initial indent.",
"default": {
"html": true
},
"properties": {
"html": {
"type": "boolean",
"default": true
},
"pug": {
"type": "boolean",
"default": false
},
"typescript": {
"type": "boolean",
"default": false
},
"javascript": {
"type": "boolean",
"default": false
},
"typescriptreact": {
"type": "boolean",
"default": false
},
"javascriptreact": {
"type": "boolean",
"default": false
},
"css": {
"type": "boolean",
"default": false
},
"scss": {
"type": "boolean",
"default": false
},
"json": {
"type": "boolean",
"default": false
},
"jsonc": {
"type": "boolean",
"default": false
}
}
},
"volar.takeOverMode.enabled": {
"type": [
"boolean",
Expand Down
3 changes: 3 additions & 0 deletions packages/shared/src/node.ts
@@ -1,3 +1,6 @@
export * from './browser';
export * from './ts_node';
export * from './http';

// fix build
export * as _0 from 'vscode-languageserver-textdocument';
Expand Up @@ -17,6 +17,9 @@ export function register(

const fileName = shared.getPathOfUri(document.uri);
const tsOptions = await settings.getFormatOptions?.(document.uri, options) ?? options;
if (typeof(tsOptions.indentSize) === "boolean" || typeof(tsOptions.indentSize) === "string") {
tsOptions.indentSize = undefined;
}

let scriptEdits: ReturnType<typeof languageService.getFormattingEditsForRange> | undefined;
try {
Expand Down
11 changes: 10 additions & 1 deletion packages/vue-language-core/src/plugins/vue-sfc-customblocks.ts
@@ -1,5 +1,12 @@
import { VueLanguagePlugin } from '../sourceFile';

const presetInitialIndentBrackets: Record<string, [string, string] | undefined> = {
json: ['{', '}'],
jsonc: ['{', '}'],
html: ['<template>', '</template>'],
markdown: ['<template>', '</template>'],
};

const plugin: VueLanguagePlugin = () => {

return {
Expand All @@ -22,7 +29,9 @@ const plugin: VueLanguagePlugin = () => {
embeddedFile.capabilities = {
diagnostics: true,
foldingRanges: true,
formatting: true,
formatting: {
initialIndentBracket: presetInitialIndentBrackets[customBlock.lang],
},
documentSymbol: true,
codeActions: true,
inlayHints: true,
Expand Down
4 changes: 3 additions & 1 deletion packages/vue-language-core/src/plugins/vue-sfc-scripts.ts
Expand Up @@ -23,7 +23,9 @@ const plugin: VueLanguagePlugin = () => {
embeddedFile.capabilities = {
diagnostics: false,
foldingRanges: true,
formatting: true,
formatting: {
initialIndentBracket: ['{', '}'],
},
documentSymbol: true,
codeActions: false,
inlayHints: false,
Expand Down
11 changes: 9 additions & 2 deletions packages/vue-language-core/src/plugins/vue-sfc-styles.ts
@@ -1,5 +1,10 @@
import { VueLanguagePlugin } from '../sourceFile';

const presetInitialIndentBrackets: Record<string, [string, string] | undefined> = {
css: ['{', '}'],
scss: ['{', '}'],
};

const plugin: VueLanguagePlugin = () => {

return {
Expand All @@ -22,7 +27,9 @@ const plugin: VueLanguagePlugin = () => {
embeddedFile.capabilities = {
diagnostics: true,
foldingRanges: true,
formatting: true,
formatting: {
initialIndentBracket: presetInitialIndentBrackets[style.lang],
},
documentSymbol: true,
codeActions: true,
inlayHints: true,
Expand All @@ -48,5 +55,5 @@ const plugin: VueLanguagePlugin = () => {
}
},
};
}
};
export = plugin;
9 changes: 8 additions & 1 deletion packages/vue-language-core/src/plugins/vue-sfc-template.ts
@@ -1,5 +1,10 @@
import { VueLanguagePlugin } from '../sourceFile';

const presetInitialIndentBrackets: Record<string, [string, string] | undefined> = {
html: ['<template>', '</template>'],
pug: ['div', '\n'],
};

const plugin: VueLanguagePlugin = () => {

return {
Expand All @@ -17,7 +22,9 @@ const plugin: VueLanguagePlugin = () => {
embeddedFile.capabilities = {
diagnostics: true,
foldingRanges: true,
formatting: true,
formatting: {
initialIndentBracket: presetInitialIndentBrackets[sfc.template.lang],
},
documentSymbol: true,
codeActions: true,
inlayHints: true,
Expand Down
4 changes: 3 additions & 1 deletion packages/vue-language-core/src/sourceFile.ts
Expand Up @@ -74,7 +74,9 @@ export interface EmbeddedFile {
capabilities: {
diagnostics: boolean,
foldingRanges: boolean,
formatting: boolean,
formatting: boolean | {
initialIndentBracket?: [string, string],
},
documentSymbol: boolean,
codeActions: boolean,
inlayHints: boolean,
Expand Down
96 changes: 61 additions & 35 deletions packages/vue-language-service/src/documentFeatures/format.ts
Expand Up @@ -3,6 +3,7 @@ import * as vscode from 'vscode-languageserver-protocol';
import type { EmbeddedStructure } from '@volar/vue-language-core';
import type { DocumentServiceRuntimeContext } from '../types';
import { EmbeddedDocumentSourceMap, VueDocument } from '../vueDocuments';
import { useConfigurationHost } from '@volar/vue-language-service-types';

export function register(context: DocumentServiceRuntimeContext) {

Expand All @@ -24,8 +25,8 @@ export function register(context: DocumentServiceRuntimeContext) {

const originalDocument = document;
const rootEdits = onTypeParams
? await tryFormatOnType(document, onTypeParams.position, onTypeParams.ch)
: await tryFormat(document, range);
? await tryFormat(document, onTypeParams.position, undefined, onTypeParams.ch)
: await tryFormat(document, range, undefined);
const vueDocument = context.getVueDocument(document);

if (!vueDocument)
Expand All @@ -37,6 +38,8 @@ export function register(context: DocumentServiceRuntimeContext) {

let level = 0;

const initialIndentLanguageId = await useConfigurationHost()?.getConfiguration<Record<string, boolean>>('volar.initialIndent') ?? { html: true };

while (true) {

tryUpdateVueDocument();
Expand All @@ -57,6 +60,9 @@ export function register(context: DocumentServiceRuntimeContext) {
continue;

const sourceMap = vueDocument.sourceMapsMap.get(embedded.self);
const initialIndentBracket = typeof embedded.self.file.capabilities.formatting === 'object' && initialIndentLanguageId[sourceMap.mappedDocument.languageId]
? embedded.self.file.capabilities.formatting.initialIndentBracket
: undefined;

let _edits: vscode.TextEdit[] | undefined;

Expand All @@ -65,7 +71,12 @@ export function register(context: DocumentServiceRuntimeContext) {
const embeddedPosition = sourceMap.getMappedRange(onTypeParams.position)?.[0].start;

if (embeddedPosition) {
_edits = await tryFormatOnType(sourceMap.mappedDocument, embeddedPosition, onTypeParams.ch);
_edits = await tryFormat(
sourceMap.mappedDocument,
embeddedPosition,
initialIndentBracket,
onTypeParams.ch,
);
}
}

Expand Down Expand Up @@ -103,7 +114,11 @@ export function register(context: DocumentServiceRuntimeContext) {
sourceMapEmbeddedDocumentUri: sourceMap.mappedDocument.uri,
};

_edits = await tryFormat(sourceMap.mappedDocument, embeddedRange);
_edits = await tryFormat(
sourceMap.mappedDocument,
embeddedRange,
initialIndentBracket,
);
}
}

Expand Down Expand Up @@ -182,21 +197,41 @@ export function register(context: DocumentServiceRuntimeContext) {
}
}

async function tryFormat(document: TextDocument, range: vscode.Range) {
async function tryFormat(document: TextDocument, range: vscode.Range | vscode.Position, initialIndentBracket: [string, string] | undefined, ch?: string) {

const plugins = context.getFormatPlugins();
const plugins = context.getPlugins();

context.updateTsLs(document);
let formatDocument = document;
let formatRange = range;

for (const plugin of plugins) {
if (initialIndentBracket) {
formatDocument = TextDocument.create(
document.uri,
document.languageId,
document.version,
initialIndentBracket[0] + document.getText() + initialIndentBracket[1],
);
formatRange = {
start: formatDocument.positionAt(0),
end: formatDocument.positionAt(formatDocument.getText().length),
};
}

if (!plugin.format)
continue;
context.updateTsLs(formatDocument);

for (const plugin of plugins) {

let edits: vscode.TextEdit[] | null | undefined;

try {
edits = await plugin.format(document, range, options);
if (vscode.Position.is(formatRange)) {
if (ch !== undefined) {
edits = await plugin.formatOnType?.(formatDocument, formatRange, ch, options);
}
}
else {
edits = await plugin.format?.(formatDocument, formatRange, options);
}
}
catch (err) {
console.error(err);
Expand All @@ -205,34 +240,25 @@ export function register(context: DocumentServiceRuntimeContext) {
if (!edits)
continue;

return edits;
}
}

async function tryFormatOnType(document: TextDocument, position: vscode.Position, ch: string) {

const plugins = context.getFormatPlugins();
if (!edits.length)
return edits;

context.updateTsLs(document);
let newText = TextDocument.applyEdits(formatDocument, edits);

for (const plugin of plugins) {

if (!plugin.formatOnType)
continue;

let edits: vscode.TextEdit[] | null | undefined;

try {
edits = await plugin.formatOnType(document, position, ch, options);
if (initialIndentBracket) {
newText = newText.substring(
newText.indexOf(initialIndentBracket[0]) + initialIndentBracket[0].length,
newText.lastIndexOf(initialIndentBracket[1]),
);
}
catch (err) {
console.error(err);
}

if (!edits)
continue;

return edits;
return [{
range: {
start: document.positionAt(0),
end: document.positionAt(document.getText().length),
},
newText,
}];
}
}

Expand Down