require-vitepress-clean-urls-explicit

Require explicit cleanUrls in committed VitePress config.

Rule catalog ID: R067

Targeted pattern scope

.vitepress/config.*
cleanUrls

What this rule reports

This rule reports VitePress config files that do not define cleanUrls.

Why this rule exists

Setting cleanUrls explicitly makes routing/deployment behavior intentional across environments. Implicit defaults can lead to surprises when hosting docs on different platforms.

❌ Incorrect

import { defineConfig } from "vitepress";

export default defineConfig({
    title: "Project Docs",
});

✅ Correct

import { defineConfig } from "vitepress";

export default defineConfig({
    title: "Project Docs",
    cleanUrls: true,
});

Behavior and migration notes

this rule only applies to .vitepress/config.*
either true or false satisfies explicitness

ESLint flat config example

import vite from "@typpi/eslint-plugin-vite";

export default [vite.configs.vitepress];

When not to use it

Disable this rule only if your deployment pipeline controls URL cleanliness independently and you intentionally avoid this key.

Package documentation

VitePress config reference

Targeted pattern scope​

What this rule reports​

Why this rule exists​

❌ Incorrect​

✅ Correct​

Behavior and migration notes​

ESLint flat config example​

When not to use it​

Package documentation​

Further reading​