tools README

The project's README from github.com/rome/tools. As one markdown file: README.md.

[!IMPORTANT]

Welcome to Biome, the community successor of Rome!

[!WARNING]

Rome won't be maintained anymore by the same people that maintained it so far. Biome will provide new features and fixes.

Rome's logo depicting an ancient Roman arch with the word Rome to its side

MIT licensed Discord chat CI on main npm version VSCode version

Rome is a formatter, linter, bundler, and more for JavaScript, TypeScript, JSON, HTML, Markdown, and CSS.

Rome is designed to replace Babel, ESLint, webpack, Prettier, Jest, and others.

Rome unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelizing work, caching, and configuration.

Rome has strong conventions and aims to have minimal configuration. Read more about our project philosophy.

Rome is written in Rust.

Rome has first-class IDE support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.

Rome is MIT licensed and moderated under the Contributor Covenant Code of Conduct.

Documentation

Check out our homepage to learn more about Rome, or directly head to the Getting Started guide if you want to start using Rome.

Technical documentation

Browse Rome's internal Rust API Documentation if you're interested to learn more about how Rome works.

tools (rome/tools)

Searching Database…

23.4K ·GitHub
archived
What is this?Rome is a unified toolchain for JavaScript, TypeScript, and the web: one program that formats, lints, and bundles code, built to replace separate tools like Babel, ESLint, webpack, Prettier, and Jest.
Is it a bunch of separate tools stitched together, or one program?One program. Rome unifies what used to live in separate tools, so formatting, linting, and bundling share a single base — one error display, parallel execution, caching, and one configuration.
How do I get it running?Follow the Getting Started guide on the Rome homepage; the tool ships as an npm package, and a VSCode extension is available for editor integration.
Do I need to install anything else before running it?Nothing extra: Rome is written in Rust, so it runs as a compiled binary; it is distributed as an npm package, with a VSCode extension on top.
Is Rome still maintained?No. The original team stopped maintaining it, and the repository now points users to Biome, the community successor that receives new features and fixes.
Is it free to use, including commercially?Yes — MIT licensed, so free for any use; the project is also moderated under the Contributor Covenant Code of Conduct.
Why pick one unified tool over ESLint plus Prettier plus webpack?Because a shared base gives a cohesive experience: consistent error display across tools, parallelized work, caching, and a single configuration instead of several overlapping config files.
What is Biome, and should I start there instead?Biome is the community-maintained successor to Rome; the Rome repo itself says Biome will provide the new features and fixes, so new projects should look at Biome first.
How much configuration does Rome need?Very little by design: Rome has strong conventions built in and aims to work with minimal configuration.
What are similar projects?biome, oxc, closure-compiler, knip, prettier, stylelint, ruff, snowpack
Creator
rome
Size
141.6 MB
Stars
23.4K
Age
6y
Commits · 90 Days