volar-service-prettier

0.0.70 verified Sat Apr 25 auth: no javascript

Volar plugin integrating Prettier formatting into Volar-based language services. Latest version 0.0.70, released frequently. Provides formatting via Prettier for configurable language scopes (HTML, CSS, SCSS, TypeScript, JavaScript). Supports Prettier v2 and v3. Key differentiator: designed for Volar ecosystem, allowing direct use in Volar language servers without manual Prettier integration.

Common errors

error Cannot find module 'volar-service-prettier' ↓

cause Package not installed or not in node_modules.

fix

Run npm install volar-service-prettier.

error TypeError: create is not a function ↓

cause Incorrect import: using default import instead of named import.

fix

Use const { create } = require('volar-service-prettier') or import { create } from 'volar-service-prettier'.

error Error: Missing peer dependency prettier ↓

cause Prettier not installed or version incompatible.

fix

Run npm install prettier@^3.0 or see peer dep requirements.

Warnings

deprecated The 'create' function may be deprecated in favor of future service registration patterns. ↓

fix Check changelog and migrate to new API if available.

gotcha Prettier version must be compatible (^2.2 || ^3.0). Using unsupported version may cause runtime errors. ↓

fix Install Prettier v2.2+ or v3 with `npm install prettier@^3.0`.

gotcha The 'ignoreIdeOptions' option, when true, ignores Prettier settings defined in IDE/editor, which may cause unexpected formatting differences. ↓

fix Set to false if you want to respect IDE settings, or true for consistent behavior across environments.

breaking Peer dependency @volar/language-service must be ~2.4.0. Version mismatches break import. ↓

fix Ensure your project uses @volar/language-service version 2.4.x.

Install

npm install volar-service-prettier

yarn add volar-service-prettier

pnpm add volar-service-prettier

Imports

create

wrong

const volarServicePrettier = require('volar-service-prettier')

correct

import { create } from 'volar-service-prettier'

Default export is not available; named export 'create' must be used.

create (CommonJS)

wrong

const create = require('volar-service-prettier')

correct

const { create } = require('volar-service-prettier')

In CJS, destructure 'create' from module.

TypeScript types

import type { PrettierServiceOptions } from 'volar-service-prettier'

Types are exported; use import type for type-only usage.

Quickstart

Shows how to configure and register volar-service-prettier in a Volar config file using CommonJS with language scoping and custom Prettier options.

const { create } = require('volar-service-prettier');

module.exports = {
  services: [
    create(
      {
        languages: ['html', 'css', 'scss', 'typescript', 'javascript'],
        html: {
          breakContentsFromTags: true,
        },
        ignoreIdeOptions: true,
      },
      () => ({
        semi: false,
        singleQuote: true,
      })
    ),
  ],
};