prettier-plugin-qingkuai

1.0.30 verified Sat Apr 25 auth: no javascript

Prettier plugin for formatting .qk (Qingkuai) files. Current stable version: 1.0.30. Release cadence is irregular. It relies on the Qingkuai compiler for parsing, providing Prettier-compatible formatting. Key differentiator: it's the only formatter for the niche .qk file format (likely China-specific). Requires Prettier ^3.5.3 and qingkuai ^1.0.46 as peer dependencies. Ships TypeScript types.

Common errors

error Cannot find module 'prettier-plugin-qingkuai' ↓

cause Plugin not installed or peer dependencies missing.

fix

Run: npm install prettier qingkuai prettier-plugin-qingkuai

error Error: Couldn't resolve parser "qingkuai" ↓

cause Missing or incompatible qingkuai peer dependency.

fix

Install qingkuai@^1.0.46: npm install qingkuai@^1.0.46

Warnings

gotcha Plugin requires both prettier ^3.5.3 and qingkuai ^1.0.46 as peer dependencies. Using incompatible versions will cause silent failures or incorrect formatting. ↓

fix Ensure you have prettier@^3.5.3 and qingkuai@^1.0.46 installed.

breaking Version 1.0.0 dropped support for Prettier <3.0. If you're using Prettier 2.x, do not upgrade. ↓

fix Use prettier-plugin-qingkuai@0.x for Prettier 2.x.

gotcha The plugin exports a default plugin object. If you import named exports like { prettierPluginQingkuai }, it will be undefined. ↓

fix Use default import: import plugin from 'prettier-plugin-qingkuai'.

Install

npm install prettier-plugin-qingkuai

yarn add prettier-plugin-qingkuai

pnpm add prettier-plugin-qingkuai

Imports

default plugin object

wrong

import { prettierPluginQingkuai } from 'prettier-plugin-qingkuai';

correct

const plugin = require('prettier-plugin-qingkuai');
// or with ESM:
import plugin from 'prettier-plugin-qingkuai';

Plugin is a default export; named exports are deprecated.

types

import type { QkOptions } from 'prettier-plugin-qingkuai';

Type exports are available if the plugin provides them.

Quickstart

Shows how to set up .prettierrc.json with the plugin and run prettier to format a .qk file.

// Install peer dependencies:
// npm install prettier qingkuai prettier-plugin-qingkuai

// .prettierrc.json
{
  "plugins": ["prettier-plugin-qingkuai"],
  "overrides": [
    {
      "files": "*.qk",
      "options": {
        "parser": "qingkuai"
      }
    }
  ]
}

// Format a file:
// Run: npx prettier --write file.qk