Registry / devops / prettier-plugin-xquery

prettier-plugin-xquery

library1.6.1jsnpmunverified

Prettier plugin for formatting XQuery files. Current stable version is 1.6.1. Released irregularly as needed. Uses the standard Prettier plugin API, supports XQuery dialects (Exist DB, XQuery Update Facility 3.0) and works with common Prettier options like printWidth, tabWidth, singleQuote, useTabs. Provides a demo page and TypeScript type definitions. Alternative to manual code formatting/indentation in XQuery.

devops

npm install prettier-plugin-xquery

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-XQ

prettier-plugin-xquery

devopsjavascriptv1.6.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

prettier-plugin-xquery

✓ // No default import; used in config: plugins: ['prettier-plugin-xquery']

✗ import prettierPluginXQuery from 'prettier-plugin-xquery';

The plugin is loaded as a string in the Prettier config 'plugins' array. Direct import is not typical.

prettier-plugin-xquery (in config)

✓ plugins: ['prettier-plugin-xquery']

✗ plugins: ['prettier-plugin-xquery'] // correct spelling; often misspelled as 'prettier-plugin-xquery'

Plugin must be declared in .prettierrc or passed via CLI --plugin.

prettier-plugin-xquery (CLI)

✓ prettier --plugin=prettier-plugin-xquery --write '**/*.xq*'

✗ prettier --write '**/*.xq*'

If not in config file, --plugin flag must be used every invocation.

Install plugin and format XQuery files. Shows CLI usage and basic config with type definitions.

// Install dependencies npm install --save-dev prettier prettier-plugin-xquery // Format all .xq files in place via CLI npx prettier --plugin=prettier-plugin-xquery --write '**/*.xq*' // Or create .prettierrc.json { "plugins": ["prettier-plugin-xquery"], "tabWidth": 4 }

Debug

Known issues

gotchaPlugin must be explicitly listed in Prettier config or CLI --plugin. Prettier does not auto-discover plugins.

fix

Add 'prettier-plugin-xquery' to the plugins array in .prettierrc or pass --plugin=prettier-plugin-xquery.

affects: >=1.0

gotchaThe plugin may not format files without proper file extension (.xq, .xql, .xqm, .xquery). Glob patterns may need adjustment.

fix

Use glob '**/*.xq*' to cover common extensions.

affects: >=1.0

deprecatedPrettier plugins using the old API (v1/v2) may require prettier version compatibility.

fix

Use prettier >=2.0 and ensure plugin is updated; check plugin's peerDependencies.

affects: >=1.0 <2.0

Errors

Common errors & fixes

Cannot find module 'prettier-plugin-xquery'

Plugin not installed or not in node_modules.

fix

npm install --save-dev prettier-plugin-xquery

[error] Couldn't resolve plugin "prettier-plugin-xquery". The plugin name is correct?

Plugin name misspelled or not specified in config.

fix

Check spelling and ensure it's listed under 'plugins' in .prettierrc.

Upgrade

Version history

1.6.1latest on npm

Audit

Dependencies

prettierrequiredRequired peer dependency; plugin is loaded by Prettier.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/DrRataplan/prettier-plugin-xquery ↗

packageprettier-plugin-xquery ↗

homepagehttps://github.com/DrRataplan/prettier-plugin-xquery#readme ↗