Revert "Use yaml package for formatting"

This reverts commit 22d01b4.

There were many bugs in the new formatter implementation,
so we're reverting for now.

In order to move forwards with this,
we'll either need to adjust the behaviour of `toString` in the YAML parser
through contributing patches,
or write our own formatter.

Fixes redhat-developer/vscode-yaml#1237
Fixes redhat-developer/vscode-yaml#1235
Fixes redhat-developer/vscode-yaml#1234
Fixes redhat-developer/vscode-yaml#1233
Fixes #1237

Author: datho7561

package-lock.json

@@ -31,6 +31,7 @@
     "ajv": "^8.17.1",
     "ajv-draft-04": "^1.0.0",
     "ajv-i18n": "^4.2.0",
+    "prettier": "^3.8.1",
     "request-light": "^0.5.7",
     "vscode-json-languageservice": "4.1.8",
     "vscode-languageserver": "^9.0.0",
@@ -56,7 +57,6 @@
     "mocha": "11.7.1",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^15.1.0",
-    "prettier": "3.8.1",
     "rimraf": "^3.0.2",
     "sinon": "^9.0.3",
     "sinon-chai": "^3.5.0",

package.json

@@ -106,6 +106,7 @@ export class SettingsHandler {
 
       if (settings.yaml.format) {
         this.yamlSettings.yamlFormatterSettings = {
+          proseWrap: settings.yaml.format.proseWrap || 'preserve',
           printWidth: settings.yaml.format.printWidth || 80,
         };
 

src/languageserver/handlers/settingsHandlers.ts

@@ -4,23 +4,20 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { TextDocument } from 'vscode-languageserver-textdocument';
-import { FormattingOptions, Position, Range, TextEdit } from 'vscode-languageserver-types';
-import { parseDocument, ToStringOptions } from 'yaml';
-import { YamlVersion } from '../parser/yamlParser07';
+import { Range, Position, TextEdit, FormattingOptions } from 'vscode-languageserver-types';
 import { CustomFormatterOptions, LanguageSettings } from '../yamlLanguageService';
-import { getCustomTags } from '../parser/custom-tag-provider';
+import { Options } from 'prettier';
+import * as yamlPlugin from 'prettier/plugins/yaml';
+import * as estreePlugin from 'prettier/plugins/estree';
+import { format } from 'prettier/standalone';
+import { TextDocument } from 'vscode-languageserver-textdocument';
 
 export class YAMLFormatter {
   private formatterEnabled = true;
-  private yamlVersion: YamlVersion = '1.2';
-  private customTags: string[] = [];
 
   public configure(shouldFormat: LanguageSettings): void {
     if (shouldFormat) {
       this.formatterEnabled = shouldFormat.format;
-      this.yamlVersion = shouldFormat.yamlVersion;
-      this.customTags = shouldFormat.customTags;
     }
   }
 
@@ -34,28 +31,24 @@ export class YAMLFormatter {
 
     try {
       const text = document.getText();
-      const doc = parseDocument(text, {
-        version: this.yamlVersion,
-        customTags: getCustomTags(this.customTags),
-      });
 
-      const toStringOptions: ToStringOptions = {
+      const prettierOptions: Options = {
+        parser: 'yaml',
+        plugins: [yamlPlugin, estreePlugin],
+
         // --- FormattingOptions ---
-        indent: (options.tabWidth as number) || options.tabSize || 2,
+        tabWidth: (options.tabWidth as number) || options.tabSize,
 
         // --- CustomFormatterOptions ---
         singleQuote: options.singleQuote,
-        flowCollectionPadding: options.bracketSpacing,
-        blockQuote: options.proseWrap === 'always' ? 'folded' : true,
-        lineWidth: Math.max(options.printWidth || 0, 22),
-        trailingComma: options.trailingComma === undefined ? true : options.trailingComma,
+        bracketSpacing: options.bracketSpacing,
+        // 'preserve' is the default for Options.proseWrap. See also server.ts
+        proseWrap: 'always' === options.proseWrap ? 'always' : 'never' === options.proseWrap ? 'never' : 'preserve',
+        printWidth: options.printWidth,
+        trailingComma: options.trailingComma === false ? 'none' : 'all',
       };
 
-      const formatted = doc.toString(toStringOptions);
-
-      if (formatted === text) {
-        return [];
-      }
+      const formatted = await format(text, prettierOptions);
 
       return [TextEdit.replace(Range.create(Position.create(0, 0), document.positionAt(text.length)), formatted)];
     } catch (error) {

src/languageservice/services/yamlFormatter.ts

@@ -86,19 +86,7 @@ describe('Formatter Tests', () => {
           printWidth: 20,
           proseWrap: 'always',
         });
-        assert.equal(edits[0].newText, 'comments: >\n  test test test test\n  test test test test\n  test test test test\n');
-      });
-
-      it('Formatting handles trailing commas (default)', async () => {
-        const content = `{
-  key: 'value',
-  food: 'raisins',
-  airport: 'YYZ',
-  lightened_bulb: 'illuminating',
-}
-`;
-        const edits = await parseSetup(content, { singleQuote: true, trailingComma: true });
-        assert.equal(edits.length, 0);
+        assert.equal(edits[0].newText, 'comments: >\n  test test test\n  test test test\n  test test test\n  test test test\n');
       });
 
       it('Formatting handles trailing commas (enabled)', async () => {
@@ -110,7 +98,7 @@ describe('Formatter Tests', () => {
 }
 `;
         const edits = await parseSetup(content, { singleQuote: true });
-        assert.equal(edits.length, 0);
+        assert.equal(edits[0].newText, content);
       });
 
       it('Formatting handles trailing commas (disabled)', async () => {