volar-service-prettier 0.0.0

package/README.md

@@ -0,0 +1,37 @@
+# volar-service-prettier
+
+Volar plugin for [prettier](https://prettier.io/).
+
+## Usage
+
+`package.json`
+
+```json
+{
+  "devDependencies": {
+    "volar-service-prettier": "latest"
+  }
+}
+```
+
+`volar.config.js`
+
+```js
+module.exports = {
+	plugins: [
+		require('volar-service-prettier').default(
+			{
+				languages: ['html', 'css', 'scss', 'typescript', 'javascript'],
+				html: {
+					breakContentsFromTags: true,
+				},
+				ignoreIdeOptions: true,
+			},
+			// provide your prettier options, otherwise auto resolve config file by plugin
+			() => ({
+				// ...
+			})
+		),
+	],
+};
+```

package/out/index.d.ts

@@ -0,0 +1,35 @@
+import type { Service } from '@volar/language-service';
+import { type Options, type ResolveConfigOptions } from 'prettier';
+declare const _default: (options?: {
+    /**
+     * Languages to be formatted by prettier.
+     *
+     * @default
+     * ['html', 'css', 'scss', 'typescript', 'javascript']
+     */
+    languages?: string[] | undefined;
+    html?: {
+        /**
+         * Preprocessing to break "contents" from "HTML tags".
+         * This will prevent HTML closing tags, and opening tags without attributes
+         * from breaking into a blank `>` or `<` on a new line.
+         */
+        breakContentsFromTags?: boolean | undefined;
+    } | undefined;
+    /**
+     * Do not use settings from VSCode's `editor.tabSize` and temporary tabSize on status bar
+     *
+     * @see https://github.com/volarjs/services/issues/5
+     */
+    ignoreIdeOptions?: boolean | undefined;
+    /**
+     * Additional options to pass to Prettier
+     * This is useful, for instance, to add specific plugins you need.
+     */
+    additionalOptions?: ((resolvedConfig: Options) => Options) | undefined;
+    /**
+     * Options to use when resolving the Prettier config
+     */
+    resolveConfigOptions?: ResolveConfigOptions | undefined;
+}, getPrettierConfig?: (config?: ResolveConfigOptions) => Options) => Service;
+export default _default;

package/out/index.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prettier_1 = require("prettier");
+exports.default = (options = {}, getPrettierConfig = (config) => {
+    const configFile = prettier_1.resolveConfigFile.sync();
+    if (configFile) {
+        return prettier_1.resolveConfig.sync(configFile, config) ?? {};
+    }
+    return {};
+}) => (context) => {
+    if (!context) {
+        return {};
+    }
+    const languages = options.languages ?? ['html', 'css', 'scss', 'typescript', 'javascript'];
+    const filePrettierOptions = getPrettierConfig(options.resolveConfigOptions);
+    return {
+        async provideDocumentFormattingEdits(document, _, formatOptions) {
+            if (!languages.includes(document.languageId)) {
+                return;
+            }
+            const fileInfo = await (0, prettier_1.getFileInfo)(context.env.uriToFileName(document.uri), { ignorePath: '.prettierignore' });
+            if (fileInfo.ignored) {
+                return;
+            }
+            const editorPrettierOptions = await context.env.getConfiguration?.('prettier', document.uri);
+            const ideFormattingOptions = formatOptions !== undefined && !options.ignoreIdeOptions // We need to check for options existing here because some editors might not have it
+                ? {
+                    tabWidth: formatOptions.tabSize,
+                    useTabs: !formatOptions.insertSpaces,
+                }
+                : {};
+            const fullText = document.getText();
+            let oldText = fullText;
+            const isHTML = document.languageId === 'html';
+            if (isHTML && options.html?.breakContentsFromTags) {
+                oldText = oldText
+                    .replace(/(<[a-z][^>]*>)([^ \n])/gi, '$1 $2')
+                    .replace(/([^ \n])(<\/[a-z][a-z0-9\t\n\r -]*>)/gi, '$1 $2');
+            }
+            // Return a config with the following cascade:
+            // - Prettier config file should always win if it exists, if it doesn't:
+            // - Prettier config from the VS Code extension is used, if it doesn't exist:
+            // - Use the editor's basic configuration settings
+            const prettierOptions = returnObjectIfHasKeys(filePrettierOptions) || returnObjectIfHasKeys(editorPrettierOptions) || ideFormattingOptions;
+            const currentPrettierConfig = {
+                ...options.additionalOptions ? options.additionalOptions(prettierOptions) : prettierOptions,
+                filepath: context.env.uriToFileName(document.uri),
+            };
+            if (!options.ignoreIdeOptions) {
+                currentPrettierConfig.useTabs = !formatOptions.insertSpaces;
+                currentPrettierConfig.tabWidth = formatOptions.tabSize;
+            }
+            return [{
+                    newText: (0, prettier_1.format)(oldText, currentPrettierConfig),
+                    range: {
+                        start: document.positionAt(0),
+                        end: document.positionAt(fullText.length),
+                    },
+                }];
+        },
+    };
+};
+function returnObjectIfHasKeys(obj) {
+    if (Object.keys(obj || {}).length > 0) {
+        return obj;
+    }
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "volar-service-prettier",
+	"version": "0.0.0",
+	"main": "out/index.js",
+	"types": "out/index.d.ts",
+	"license": "MIT",
+	"files": [
+		"out/**/*.js",
+		"out/**/*.d.ts"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/volarjs/services.git",
+		"directory": "packages/prettier"
+	},
+	"author": {
+		"name": "Pacharapol Withayasakpunt",
+		"email": "polv@polv.cc",
+		"url": "https://www.polv.cc"
+	},
+	"devDependencies": {
+		"@types/prettier": "^2.7.2"
+	},
+	"peerDependencies": {
+		"@volar/language-service": "*",
+		"prettier": "*"
+	},
+	"peerDependenciesMeta": {
+		"@volar/language-service": {
+			"optional": true
+		}
+	},
+	"gitHead": "1011561ac4bbf79c53c3b80c27692569bf861519"
+}