Open Grind

Repositories

7

Projects Packages

2

Code

@opengrind/config (1.1.0)

Published 2026-08-06 18:23:25 +02:00 by forgejo

Installation

Setup this registry in your project .npmrc file:

@opengrind:registry=

To install the package using npm, run the following command:

npm install @opengrind/config@1.1.0

or add it to the package.json file:

"@opengrind/config": "1.1.0"

For more information on the npm registry, see the documentation.

About this package

@opengrind/config

Shared ESLint, Prettier, lint-staged, rustfmt and EditorConfig settings for the Open Grind repositories.

Install

Point the scope at the Forgejo registry in bunfig.toml:

[install.scopes]
"@opengrind" = { url = "https://git.opengrind.org/api/packages/open-grind/npm/" }

bun add -d @opengrind/config

Consumers declare only eslint and prettier. Every plugin is a dependency of this package and resolves from it.

Keep it in devDependencies. It is lint-time only and must never enter a bundler's import graph, or it becomes part of a reproducible build.

ESLint

SvelteKit app:

import { sveltekit } from "@opengrind/config/eslint/svelte";
import { defineConfig } from "eslint/config";

import svelteConfig from "./svelte.config.js";

export default defineConfig(
	...sveltekit({
		svelteConfig,
		tailwindEntry: "src/layout.css",
		vendoredGlob: "src/lib/components/ui/**",
		ignores: [
			"src-tauri/",
			"reverse/",
			"docs/",
			"contrib/",
			"static/",
			"scripts/",
		],
	}),
);

svelteConfig is passed in because a repo's svelte.config.js may run arbitrary code at import time, so this package cannot import it.

Browser extension:

import { webextension } from "@opengrind/config/eslint/webext";

export default webextension();

Plain TypeScript:

import { typescriptBase } from "@opengrind/config/eslint";

Prettier

// prettier.config.js
import { sveltekit } from "@opengrind/config/prettier/svelte";

export default sveltekit({ tailwindStylesheet: "./src/layout.css" });

Non-Svelte repos can use the package.json field instead:

{ "prettier": "@opengrind/config/prettier" }

lint-staged

import { withRust } from "@opengrind/config/lint-staged";

export default withRust({ manifestPath: "src-tauri/Cargo.toml" });

Repos without Rust use base().

rustfmt and EditorConfig

rustfmt has no extends mechanism and does not read .editorconfig, so these two ship as files to copy:

cp node_modules/@opengrind/config/rustfmt.toml rustfmt.toml
cp node_modules/@opengrind/config/editorconfig .editorconfig

Guard against drift in CI:

diff -q rustfmt.toml node_modules/@opengrind/config/rustfmt.toml
diff -q .editorconfig node_modules/@opengrind/config/editorconfig

The comparison is against the pinned package, so it needs no network and fails only after you bump the version.

max_line_length = 80 matches Prettier's default printWidth and rustfmt's max_width. Prettier reads .editorconfig, so changing it reformats the tree.

Releasing

OG_REGISTRY_TOKEN=<forgejo-token> bun publish

Bump version first. The registry rejects a re-publish of an existing name and version.

Dependencies

Dependencies

ID	Version
@eslint/js	^10.0.1
eslint-config-prettier	^10.1.8
eslint-plugin-better-tailwindcss	^4.6.0
eslint-plugin-perfectionist	^5.9.0
eslint-plugin-svelte	^3.17.1
globals	^17.6.0
prettier-plugin-svelte	^3.5.1
prettier-plugin-tailwindcss	^0.8.0
typescript-eslint	^8.59.2

Peer dependencies

ID	Version
eslint	>=9
prettier	>=3.5

Details

npm

2026-08-06 18:23:25 +02:00

7

Open Grind Governance (https://opengrind.org/governance)

MIT

5.7 KiB

Assets (1)

config-1.1.0.tgz 5.7 KiB

Versions (5) View all

1.3.1 2026-08-11

1.3.0 2026-08-06

1.2.0 2026-08-06

1.1.0 2026-08-06

1.0.0 2026-08-06