sparql-formatter

library1.0.2jsnpmunverified

A SPARQL 1.1 query formatter for Node.js and the browser. Current version 1.0.2 formats SPARQL queries with customizable indentation and formatting modes (default, compact, turtle, JSON-LD). It supports both ESM imports and CommonJS require, and includes a CLI tool. Unlike ad-hoc formatters, it parses queries according to the SPARQL 1.1 spec, ensuring correctness. The package is stable with low release cadence, suitable for integration into query editors or pipelines.

database devops

npm install sparql-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SPARQL-FORMATTER

sparql-formatter

databasejavascriptv1.0.2

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.

spfmt

✓ import { spfmt } from 'sparql-formatter';

✗ const spfmt = require('sparql-formatter').spfmt;

Package supports both ESM and CJS. For CJS, require the default export and access .spfmt.

default import (spfmt)

✓ import spfmt from 'sparql-formatter';

✗ import { spfmt } from 'sparql-formatter'; // also works but not default

Default export is the spfmt object. Both patterns are valid.

spfmt.format

✓ import { spfmt } from 'sparql-formatter'; spfmt.format(query);

✗ spfmt.format(query, 'invalid_mode');

formattingMode must be one of 'default', 'compact', 'turtle', 'jsonld'.

Basic usage importing spfmt and formatting a SPARQL query with default and compact modes.

import { spfmt } from 'sparql-formatter'; const query = 'select * where {?s ?p ?o}'; console.log(spfmt.format(query, 'default', 2)); // Output: // SELECT * // WHERE { // ?s ?p ?o . // } // Compact mode: console.log(spfmt.format(query, 'compact')); // Output: SELECT * WHERE { ?s ?p ?o }

Debug

Known issues

gotchaCLI tool name conflicts with package name; use 'sparql-formatter' command.

fix

Use `npx sparql-formatter` or global install.

affects: >=1.0

gotchaFormatting mode names are case-sensitive and must be lowercase strings.

fix

Use exactly 'default', 'compact', 'turtle', or 'jsonld'.

affects: >=1.0

deprecatedNo deprecated features reported.

Errors

Common errors & fixes

SyntaxError: Unexpected token 'export'

Using ESM syntax in a non-ESM Node.js project (e.g., require() in same file).

fix

Set "type": "module" in package.json or use dynamic import().

Cannot find module 'sparql-formatter'

Package not installed or import path incorrect.

fix

Run `npm install sparql-formatter` and ensure import is from 'sparql-formatter'.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

sparqljsrequiredSPARQL parser used internally

Agent activity

16 hits · last 30 days

node