Chore/upgrade prettier v3

.github/workflows/main.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           cache: npm
 

package.json

@@ -9,7 +9,7 @@
     ],
     "scripts": {
         "build": "rollup -c",
-        "test": "ava",
+        "test": "PRETTIER_DEBUG=1 ava",
         "prepare": "npm run build",
         "prepublishOnly": "npm test"
     },
@@ -28,13 +28,11 @@
     },
     "homepage": "https://github.com/sveltejs/prettier-plugin-svelte#readme",
     "devDependencies": {
-        "@prettier/plugin-pug": "^1.16.0",
         "@rollup/plugin-commonjs": "14.0.0",
         "@rollup/plugin-node-resolve": "11.0.1",
         "@types/node": "^10.12.18",
-        "@types/prettier": "^2.4.1",
         "ava": "3.15.0",
-        "prettier": "^2.7.1",
+        "prettier": "^3.0.0-alpha.11",
         "rollup": "2.36.0",
         "rollup-plugin-typescript": "1.0.1",
         "svelte": "^3.54.0",
@@ -43,7 +41,7 @@
         "typescript": "4.1.3"
     },
     "peerDependencies": {
-        "prettier": "^1.16.4 || ^2.0.0",
+        "prettier": "^3.0.0-alpha.11",
         "svelte": "^3.2.0"
     }
 }

src/embed.ts

@@ -1,7 +1,7 @@
-import { Doc, doc, FastPath, ParserOptions } from 'prettier';
+import { Doc, doc, FastPath, Options } from 'prettier';
 import { getText } from './lib/getText';
 import { snippedTagContentAttribute } from './lib/snipTagContent';
-import { isBracketSameLine } from './options';
+import { isBracketSameLine, ParserOptions } from './options';
 import { PrintFn } from './print';
 import { isLine, removeParentheses, trimRight } from './print/doc-helpers';
 import { printWithPrependedAttributeLine } from './print/helpers';
@@ -23,86 +23,91 @@ const {
 
 export function embed(
     path: FastPath,
-    print: PrintFn,
-    textToDoc: (text: string, options: object) => Doc,
-    options: ParserOptions,
-): Doc | null {
-    const node: Node = path.getNode();
-
-    if (node.isJS) {
-        try {
-            const embeddedOptions: any = {
-                parser: expressionParser,
-            };
-            if (node.forceSingleQuote) {
-                embeddedOptions.singleQuote = true;
-            }
+    _options: Options,
+    ) {
+    return async (
+        textToDoc: (text: string, options: Options) => Promise<Doc>,
+        print: PrintFn,
+    ): Promise<Doc | undefined> => {
+        const node: Node = path.getNode();
+        const options = _options as ParserOptions
+        if (!options.locStart || !options.locEnd || !options.originalText) {
+            throw new Error(`Missing required options`)
+        }
 
-            let docs = textToDoc(
-                forceIntoExpression(
-                    // If we have snipped content, it was done wrongly and we need to unsnip it.
-                    // This happens for example for {@html `<script>{foo}</script>`}
-                    getText(node, options, true),
-                ),
-                embeddedOptions,
-            );
-            if (node.forceSingleLine) {
-                docs = removeLines(docs);
-            }
-            if (node.removeParentheses) {
-                docs = removeParentheses(docs);
+        if (node.isJS) {
+            try {
+                const embeddedOptions = {
+                    parser: expressionParser,
+                    singleQuote: node.forceSingleQuote ? true : undefined
+                };
+
+                let docs = await textToDoc(
+                    forceIntoExpression(
+                        // If we have snipped content, it was done wrongly and we need to unsnip it.
+                        // This happens for example for {@html `<script>{foo}</script>`}
+                        getText(node, options, true),
+                    ),
+                    embeddedOptions,
+                );
+                if (node.forceSingleLine) {
+                    docs = removeLines(docs);
+                }
+                if (node.removeParentheses) {
+                    docs = removeParentheses(docs);
+                }
+                return docs;
+            } catch (e) {
+                return getText(node, options, true);
             }
-            return docs;
-        } catch (e) {
-            return getText(node, options, true);
         }
-    }
 
-    const embedType = (
-        tag: 'script' | 'style' | 'template',
-        parser: 'typescript' | 'babel-ts' | 'css' | 'pug',
-        isTopLevel: boolean,
-    ) =>
-        embedTag(
-            tag,
-            options.originalText,
-            path,
-            (content) => formatBodyContent(content, parser, textToDoc, options),
-            print,
-            isTopLevel,
-            options,
-        );
-
-    const embedScript = (isTopLevel: boolean) =>
-        embedType(
-            'script',
-            // Use babel-ts as fallback because the absence does not mean the content is not TS,
-            // the user could have set the default language. babel-ts will format things a little
-            // bit different though, especially preserving parentheses around dot notation which
-            // fixes https://github.com/sveltejs/prettier-plugin-svelte/issues/218
-            isTypeScript(node) ? 'typescript' : 'babel-ts',
-            isTopLevel,
-        );
-    const embedStyle = (isTopLevel: boolean) => embedType('style', 'css', isTopLevel);
-    const embedPug = () => embedType('template', 'pug', false);
-
-    switch (node.type) {
-        case 'Script':
-            return embedScript(true);
-        case 'Style':
-            return embedStyle(true);
-        case 'Element': {
-            if (node.name === 'script') {
-                return embedScript(false);
-            } else if (node.name === 'style') {
-                return embedStyle(false);
-            } else if (isPugTemplate(node)) {
-                return embedPug();
+        const embedType = (
+            tag: 'script' | 'style' | 'template',
+            parser: 'typescript' | 'babel-ts' | 'css' | 'pug',
+            isTopLevel: boolean,
+        ) =>
+            embedTag(
+                tag,
+                options.originalText,
+                path,
+                (content) => formatBodyContent(content, parser, textToDoc, options),
+                print,
+                isTopLevel,
+                options,
+            );
+
+        const embedScript = (isTopLevel: boolean) =>
+            embedType(
+                'script',
+                // Use babel-ts as fallback because the absence does not mean the content is not TS,
+                // the user could have set the default language. babel-ts will format things a little
+                // bit different though, especially preserving parentheses around dot notation which
+                // fixes https://github.com/sveltejs/prettier-plugin-svelte/issues/218
+                isTypeScript(node) ? 'typescript' : 'babel-ts',
+                isTopLevel,
+            );
+        const embedStyle = (isTopLevel: boolean) => embedType('style', 'css', isTopLevel);
+        const embedPug = () => embedType('template', 'pug', false);
+
+        switch (node.type) {
+            case 'Script':
+                return embedScript(true);
+            case 'Style':
+                return embedStyle(true);
+            case 'Element': {
+                if (node.name === 'script') {
+                    return embedScript(false);
+                } else if (node.name === 'style') {
+                    return embedStyle(false);
+                } else if (isPugTemplate(node)) {
+                    return embedPug();
+                }
             }
         }
-    }
 
-    return null;
+        return;
+    }
 }
 
 function forceIntoExpression(statement: string) {
@@ -136,14 +141,14 @@ function getSnippedContent(node: Node) {
     }
 }
 
-function formatBodyContent(
+async function formatBodyContent(
     content: string,
     parser: 'typescript' | 'babel-ts' | 'css' | 'pug',
-    textToDoc: (text: string, options: object) => Doc,
+    textToDoc: (text: string, options: object) => Promise<Doc>,
     options: ParserOptions & { pugTabWidth?: number },
 ) {
     try {
-        const body = textToDoc(content, { parser });
+        const body = await textToDoc(content, { parser });
 
         if (parser === 'pug' && typeof body === 'string') {
             // Pug returns no docs but a final string.
@@ -181,11 +186,11 @@ function formatBodyContent(
     }
 }
 
-function embedTag(
+async function embedTag(
     tag: 'script' | 'style' | 'template',
     text: string,
     path: FastPath,
-    formatBodyContent: (content: string) => Doc,
+    formatBodyContent: (content: string) => Promise<Doc>,
     print: PrintFn,
     isTopLevel: boolean,
     options: ParserOptions,
@@ -204,7 +209,7 @@ function embedTag(
             ));
     const body: Doc = canFormat
         ? content.trim() !== ''
-            ? formatBodyContent(content)
+            ? await formatBodyContent(content)
             : content === ''
             ? ''
             : hardline

src/lib/getText.ts

@@ -1,4 +1,4 @@
-import { ParserOptions } from 'prettier';
+import { ParserOptions } from '../options';
 import { Node } from '../print/nodes';
 import { hasSnippedContent, unsnipContent } from './snipTagContent';
 

src/options.ts

@@ -1,7 +1,6 @@
-import { ParserOptions, SupportOption } from 'prettier';
+import { ParserOptions as PrettierParserOptions, SupportOption } from 'prettier';
 
-declare module 'prettier' {
-    interface RequiredOptions extends PluginOptions {}
+export interface ParserOptions<T = any> extends PrettierParserOptions<T>, Partial<PluginOptions> {
 }
 
 export interface PluginOptions {
@@ -18,7 +17,6 @@ function makeChoice(choice: string) {
 
 export const options: Record<keyof PluginOptions, SupportOption> = {
     svelteSortOrder: {
-        since: '0.6.0',
         category: 'Svelte',
         type: 'choice',
         default: 'options-scripts-markup-styles',
@@ -59,29 +57,25 @@ export const options: Record<keyof PluginOptions, SupportOption> = {
         ],
     },
     svelteStrictMode: {
-        since: '0.7.0',
         category: 'Svelte',
         type: 'boolean',
         default: false,
         description: 'More strict HTML syntax: self-closed tags, quotes in attributes',
     },
     svelteBracketNewLine: {
-        since: '0.6.0',
         category: 'Svelte',
         type: 'boolean',
         description: 'Put the `>` of a multiline element on a new line',
         deprecated: '2.5.0',
     },
     svelteAllowShorthand: {
-        since: '1.0.0',
         category: 'Svelte',
         type: 'boolean',
         default: true,
         description:
             'Option to enable/disable component attribute shorthand if attribute name and expressions are same',
     },
     svelteIndentScriptAndStyle: {
-        since: '1.2.0',
         category: 'Svelte',
         type: 'boolean',
         default: true,
@@ -130,7 +124,7 @@ export type SortOrderPart = 'scripts' | 'markup' | 'styles' | 'options';
 
 const sortOrderSeparator = '-';
 
-export function parseSortOrder(sortOrder: SortOrder): SortOrderPart[] {
+export function parseSortOrder(sortOrder: SortOrder = 'options-scripts-markup-styles'): SortOrderPart[] {
     if (sortOrder === 'none') {
         return [];
     }

src/print/helpers.ts

@@ -1,4 +1,4 @@
-import { Doc, doc, FastPath, ParserOptions } from 'prettier';
+import { Doc, doc, FastPath } from 'prettier';
 import { PrintFn } from '.';
 import { formattableAttributes } from '../lib/elements';
 import { snippedTagContentAttribute } from '../lib/snipTagContent';
@@ -18,6 +18,7 @@ import {
     TitleNode,
     WindowNode
 } from './nodes';
+import { ParserOptions } from '../options';
 
 /**
  * Determines whether or not given node