refactor: consistent formatting options in language service plugins

volarjs · Mar 12, 2024 · 61d10ed · 61d10ed
1 parent d6051d4
commit 61d10ed
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 57 deletions.
diff --git a/packages/css/index.ts b/packages/css/index.ts
@@ -1,4 +1,4 @@
-import type { CodeAction, Diagnostic, Disposable, DocumentSelector, LocationLink, Result, ServiceContext, ServicePlugin, ServicePluginInstance } from '@volar/language-service';
+import type { CodeAction, Diagnostic, Disposable, DocumentSelector, FormattingOptions, LocationLink, Result, ServiceContext, ServicePlugin, ServicePluginInstance } from '@volar/language-service';
 import * as css from 'vscode-css-languageservice';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI, Utils } from 'vscode-uri';
@@ -36,8 +36,11 @@ export function create({
  isFormattingEnabled = async (document, context) => {
  return await context.env.getConfiguration?.(document.languageId + '.format.enable') ?? true;
  },
- getFormatConfiguration = async (document, context) => {
- return await context.env.getConfiguration?.(document.languageId + '.format');
+ getFormattingOptions = async (document, options, context) => {
+ return {
+ ...options,
+ ...await context.env.getConfiguration?.(document.languageId + '.format'),
+ };
  },
  getLanguageSettings = async (document, context) => {
  return await context.env.getConfiguration?.(document.languageId);
@@ -75,7 +78,7 @@ export function create({
  useDefaultDataProvider?: boolean;
  getDocumentContext?(context: ServiceContext): css.DocumentContext;
  isFormattingEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
- getFormatConfiguration?(document: TextDocument, context: ServiceContext): Result<css.CSSFormatConfiguration | undefined>;
+ getFormattingOptions?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<css.CSSFormatConfiguration>;
  getLanguageSettings?(document: TextDocument, context: ServiceContext): Result<css.LanguageSettings | undefined>;
  getCustomData?(context: ServiceContext): Result<css.ICSSDataProvider[]>;
  onDidChangeCustomData?(listener: () => void, context: ServiceContext): Disposable;
@@ -219,11 +222,7 @@ export function create({
  return;
  }
 
- const formatSettings = await getFormatConfiguration(document, context);
- const formatOptions: css.CSSFormatConfiguration = {
- ...options,
- ...formatSettings,
- };
+ const formatOptions = await getFormattingOptions(document, options, context);
 
  let formatDocument = document;
  let prefixes = [];

diff --git a/packages/html/index.ts b/packages/html/index.ts
@@ -1,4 +1,4 @@
-import type { Disposable, DocumentSelector, Result, ServiceContext, ServicePlugin, ServicePluginInstance } from '@volar/language-service';
+import type { Disposable, DocumentSelector, FormattingOptions, Result, ServiceContext, ServicePlugin, ServicePluginInstance } from '@volar/language-service';
 import * as html from 'vscode-html-languageservice';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI, Utils } from 'vscode-uri';
@@ -42,8 +42,19 @@ export function create({
  isAutoClosingTagsEnabled = async (_document, context) => {
  return await context.env.getConfiguration?.('html.autoClosingTags') ?? true;
  },
- getFormattingOptions = async (_document, context) => {
- return await context.env.getConfiguration?.('html.format');
+ getFormattingOptions = async (_document, options, context) => {
+ const formatSettings: html.FormattingOptions = {
+ ...options,
+ endWithNewline: options.insertFinalNewline ? true : options.trimFinalNewlines ? false : undefined,
+ ...await context.env.getConfiguration?.('html.format'),
+ };
+ // https://github.com/microsoft/vscode/blob/a8f73340be02966c3816a2f23cb7e446a3a7cb9b/extensions/html-language-features/server/src/modes/htmlMode.ts#L47-L51
+ if (formatSettings.contentUnformatted) {
+ formatSettings.contentUnformatted = formatSettings.contentUnformatted + ',script';
+ } else {
+ formatSettings.contentUnformatted = 'script';
+ }
+ return formatSettings;
  },
  getCompletionConfiguration = async (_document, context) => {
  return await context.env.getConfiguration?.('html.completion');
@@ -84,7 +95,7 @@ export function create({
  isAutoCreateQuotesEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
  isAutoClosingTagsEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
  getDocumentContext?(context: ServiceContext): html.DocumentContext;
- getFormattingOptions?(document: TextDocument, context: ServiceContext): Result<html.HTMLFormatConfiguration | undefined>;
+ getFormattingOptions?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<html.HTMLFormatConfiguration>;
  getCompletionConfiguration?(document: TextDocument, context: ServiceContext): Result<html.CompletionConfiguration | undefined>;
  getHoverSettings?(document: TextDocument, context: ServiceContext): Result<html.HoverSettings | undefined>;
  getCustomData?(context: ServiceContext): Result<html.IHTMLDataProvider[]>;
@@ -211,18 +222,7 @@ export function create({
  };
  }
 
- const formatSettings: html.HTMLFormatConfiguration = {
- ...options,
- endWithNewline: options.insertFinalNewline ? true : options.trimFinalNewlines ? false : undefined,
- ...await getFormattingOptions(document, context),
- };
-
- // https://github.com/microsoft/vscode/blob/a8f73340be02966c3816a2f23cb7e446a3a7cb9b/extensions/html-language-features/server/src/modes/htmlMode.ts#L47-L51
- if (formatSettings.contentUnformatted) {
- formatSettings.contentUnformatted = formatSettings.contentUnformatted + ',script';
- } else {
- formatSettings.contentUnformatted = 'script';
- }
+ const formatSettings = await getFormattingOptions(document, options, context);
 
  let formatDocument = document;
  let prefixes = [];

diff --git a/packages/json/index.ts b/packages/json/index.ts
@@ -1,4 +1,4 @@
-import type { ServicePlugin, ServicePluginInstance, DocumentSelector, ServiceContext, Disposable, Result } from '@volar/language-service';
+import type { ServicePlugin, ServicePluginInstance, DocumentSelector, ServiceContext, Disposable, Result, FormattingOptions } from '@volar/language-service';
 import * as json from 'vscode-json-languageservice';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI, Utils } from 'vscode-uri';
@@ -28,8 +28,11 @@ export function create({
  isFormattingEnabled = async (_document, context) => {
  return await context.env.getConfiguration?.('json.format.enable') ?? true;
  },
- getFormattingOptions = async (_document, context) => {
- return await context.env.getConfiguration?.('json.format');
+ getFormattingOptions = async (_document, options, context) => {
+ return {
+ ...options,
+ ...await context.env.getConfiguration?.('json.format'),
+ };
  },
  getLanguageSettings = async context => {
  const languageSettings: json.LanguageSettings = {};
@@ -68,7 +71,7 @@ export function create({
  documentSelector?: DocumentSelector;
  getWorkspaceContextService?(context: ServiceContext): json.WorkspaceContextService;
  isFormattingEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
- getFormattingOptions?(document: TextDocument, context: ServiceContext): Result<json.FormattingOptions | undefined>;
+ getFormattingOptions?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<json.FormattingOptions>;
  getLanguageSettings?(context: ServiceContext): Result<json.LanguageSettings>;
  getDocumentLanguageSettings?(document: TextDocument, context: ServiceContext): Result<json.DocumentLanguageSettings | undefined>;
  onDidChangeLanguageSettings?(listener: () => void, context: ServiceContext): Disposable;
@@ -172,12 +175,9 @@ export function create({
  return;
  }
 
- const formatOptions = await getFormattingOptions(document, context);
+ const formatOptions = await getFormattingOptions(document, options, context);
 
- return jsonLs.format(document, range, {
- ...options,
- ...formatOptions,
- });
+ return jsonLs.format(document, range, formatOptions);
  });
  },
  };

diff --git a/packages/prettyhtml/index.ts b/packages/prettyhtml/index.ts
@@ -1,16 +1,21 @@
 import * as prettyhtml from '@starptech/prettyhtml';
-import type { DocumentSelector, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
+import type { DocumentSelector, FormattingOptions, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
 
-export type FormattingOptions = Parameters<typeof prettyhtml>[1];
+export type PrettyhtmlFormattingOptions = Parameters<typeof prettyhtml>[1];
 
 export function create({
  documentSelector = ['html'],
  isFormattingEnabled = () => true,
- getFormattingOptions = () => ({}),
+ getFormattingOptions = (_document, options) => {
+ return {
+ tabWidth: options.tabSize,
+ useTabs: !options.insertSpaces,
+ };
+ },
 }: {
  documentSelector?: DocumentSelector;
  isFormattingEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
- getFormattingOptions?(document: TextDocument, context: ServiceContext): Result<FormattingOptions>;
+ getFormattingOptions?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<PrettyhtmlFormattingOptions>;
 } = {}): ServicePlugin {
  return {
  name: 'prettyhtml',
@@ -25,11 +30,10 @@ export function create({
  return;
 
  const oldRangeText = document.getText(range);
- const newRangeText = prettyhtml(oldRangeText, {
- tabWidth: options.tabSize,
- useTabs: !options.insertSpaces,
- ...await getFormattingOptions(document, context),
- }).contents;
+ const newRangeText = prettyhtml(
+ oldRangeText,
+ await getFormattingOptions(document, options, context),
+ ).contents;
 
  if (newRangeText === oldRangeText)
  return [];

diff --git a/packages/pug-beautify/index.ts b/packages/pug-beautify/index.ts
@@ -1,11 +1,18 @@
-import type { DocumentSelector, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
+import type { DocumentSelector, FormattingOptions, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
 
 export function create({
  documentSelector = ['jade'],
  isFormattingEnabled = () => true,
+ getFormattingOptions = (_document, options) => {
+ return {
+ tab_size: options.tabSize,
+ fill_tab: !options.insertSpaces,
+ };
+ },
 }: {
  documentSelector?: DocumentSelector;
  isFormattingEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
+ getFormattingOptions?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<{}>;
 } = {}): ServicePlugin {
  return {
  name: 'pug-beautify',
@@ -20,7 +27,6 @@ export function create({
  return;
 
  const pugCode = document.getText(range);
-
  // fix https://github.com/johnsoncodehk/volar/issues/304
  if (pugCode.trim() === '')
  return;
@@ -30,11 +36,8 @@ export function create({
  const suffixesLength = pugCode.length - pugCode.trimEnd().length;
  const prefixes = pugCode.slice(0, prefixesLength);
  const suffixes = pugCode.slice(pugCode.length - suffixesLength);
-
- let newText: string = pugBeautify(pugCode, {
- tab_size: options.tabSize,
- fill_tab: !options.insertSpaces,
- });
+ const formatOptions = await getFormattingOptions(document, options, context);
+ const newText: string = pugBeautify(pugCode, formatOptions);
 
  return [{
  range,

diff --git a/packages/sass-formatter/index.ts b/packages/sass-formatter/index.ts
@@ -1,14 +1,14 @@
-import type { DocumentSelector, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
+import type { DocumentSelector, FormattingOptions, Result, ServiceContext, ServicePlugin, ServicePluginInstance, TextDocument } from '@volar/language-service';
 import { SassFormatter, SassFormatterConfig } from 'sass-formatter';
 
 export function create({
  documentSelector = ['sass'],
  isFormattingEnabled = () => true,
- getFormatterConfig,
+ getFormatterConfig = (_document, options) => options,
 }: {
  documentSelector?: DocumentSelector;
  isFormattingEnabled?(document: TextDocument, context: ServiceContext): Result<boolean>;
- getFormatterConfig?(document: TextDocument): Result<SassFormatterConfig>;
+ getFormatterConfig?(document: TextDocument, options: FormattingOptions, context: ServiceContext): Result<Partial<SassFormatterConfig>>;
 } = {}): ServicePlugin {
  return {
  name: 'sass-formatter',
@@ -22,10 +22,7 @@ export function create({
  if (!await isFormattingEnabled(document, context))
  return;
 
- const config = {
- ...options,
- ...getFormatterConfig ? await getFormatterConfig(document) : {},
- };
+ const config = await getFormatterConfig(document, options, context);
 
  // don't set when options.insertSpaces is false to avoid sass-formatter internal judge bug
  if (config.insertSpaces)