rome

library12.1.3jsnpmunverified

Rome is an all-in-one toolchain for JavaScript, TypeScript, CSS, and JSON. At version 12.1.3 (pre-1.0), it provides a unified formatter, linter, and bundler with 80+ built-in lint rules. It is designed to replace multiple tools like Prettier, ESLint, and Babel, with a focus on speed and correctness. Released monthly, it is written in Rust and offers a single binary with no configuration required for basic use. Key differentiators: no config, fast execution, and unified API. Note: Rome is currently in the process of being renamed to Biome (as of late 2023), but v12.1.3 is still under the Rome name.

devops

npm install rome

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ROME

rome

devopsjavascriptv12.1.3

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.

rome

✓ import { rome } from 'rome'

✗ const rome = require('rome');

Rome is primarily a CLI tool, but if using programmatic API, use named import. However, the programmatic API is deprecated in v12.

check

✓ import { check } from 'rome/check'

✗ import { check } from 'rome';

Subpath exports like 'rome/check' are used for specific commands.

format

✓ import { format } from 'rome/format'

✗ import { format } from 'rome';

Format API is exported from 'rome/format'.

parse

✓ import { parse } from 'rome/parse'

✗ import { parse } from 'rome';

Parse API is exported from 'rome/parse'.

Install Rome globally, then format and lint a JavaScript file from the command line.

npm install -g rome # Create a file to format/lint echo 'const x=1;' > test.js # Format in place rome format --write test.js # Lint rome check test.js

Debug

Known issues

breakingRome v12 is being renamed to Biome; future versions will be under the 'biome' name.

fix

Migrate to the 'biome' package when available.

affects: >=12.0.0

gotchaRome uses a different configuration format: JSONC with comments is NOT supported in v12.

fix

Use pure JSON for rome.json; avoid comments.

affects: >=12.0.0

deprecatedThe programmatic API (importing from 'rome') is deprecated; use subpath exports like 'rome/format' instead.

fix

Use subpath exports for specific APIs.

affects: >=12.0.0

breakingRome v12 dropped support for Node.js 12.

fix

Use Node.js 14 or later.

affects: >=12.0.0

gotchaRome's linter rules may differ from ESLint; some common rules have different names or are not available.

fix

Refer to Rome's documentation for equivalent rules.

affects: >=1.0.0

Errors

Common errors & fixes

error: Could not find config file 'rome.json' at '/path'

Rome expects a configuration file in the project root.

fix

Create a rome.json file or run `rome init` to generate one.

Error: Required runtime dependency: @napi-rs/cli

Rome uses native bindings; missing dependency.

fix

Reinstall Rome with `npm install rome` or use exact version.

TypeError: rome.check is not a function

Incorrect import of programmatic API.

fix

Use subpath exports: import { check } from 'rome/check'

Upgrade

Version history

12.1.3latest on npm

Audit

Dependencies

romerequiredThe package itself is the dependency; it's a CLI tool.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/rome/tools ↗

packagerome ↗

homepagehttps://rome.tools ↗