NOTE This package is an archived fork of astro-rome. This package will not receive updates. Please look for an alternative as soon as possible.

astro-rome 🏛️

This Astro integration brings Rome tools your Astro project.

Rome

Installation

There are two ways to add integrations to your project. Let's try the most convenient option first!

astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This command will:

1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your astro.config.* file to apply this integration

To install astro-rome, run the following from your project directory and follow the prompts:

Using NPM:

npx astro add astro-rome

Using Yarn:

yarn astro add astro-rome

Using PNPM:

pnpx astro add astro-rome

Install dependencies manually

First, install the astro-rome integration like so:

npm install -D -E astro-rome

Then, apply this integration to your astro.config.* file using the integrations property:

astro.config.ts

import rome from "astro-rome";

export default { integrations: [rome()] };

Getting started

The utility will now lint and format with Rome all of your JavaScript and TypeScript files, including CommonJS modules in the dist folder.

You can override any of the default options from the configurations of:

• rome

or disable them entirely:

astro.config.ts

import rome from "astro-rome";

export default {
	integrations: [
		rome({
			rome: false,
		}),
	],
};

Note

If you provide a rome.json config file the utility will pick it up automatically.

Warning

The configuration options from the astro.config.ts file will override the rome.json config.

If your path is different than dist be sure to update it accordingly:

astro.config.ts

import rome from "astro-rome";

export default {
	outDir: "./build",
	integrations: [
		rome({
			path: "./build",
		}),
	],
};

You can add multiple paths to validate by specifying an array as the path variable.

astro.config.ts

import rome from "astro-rome";

export default {
	integrations: [
		rome({
			path: ["./src", "./dist"],
		}),
	],
};

You can provide a filter to exclude files from formatting. A filter can be an array of regexes or a single match. You can use functions, as well to match on file names.

astro.config.ts

import rome from "astro-rome";

export default {
	integrations: [
		rome({
			exclude: [
				"firebase.ts",
				(file: string) => file === "./src/lib/test.ts",
			],
		}),
	],
};

Set logger to 0 if you do not want to see debug messages. Default is 2.

astro.config.ts

import rome from "astro-rome";

export default {
	integrations: [
		rome({
			logger: 0,
		}),
	],
};

Changelog

See CHANGELOG.md for a history of changes to this integration.