Skip to main content

require-docusaurus-faster-package-installed

Require @docusaurus/faster to be declared when stable or deprecated faster flags are configured.

Targeted pattern scopeโ€‹

This rule focuses on docusaurus.config.* files.

It reports configs that enable either:

  • future.faster
  • future.experimental_faster

without declaring:

  • @docusaurus/faster

in the nearest package manifest.

What this rule reportsโ€‹

This rule reports faster config that is enabled without the package dependency needed to support it.

Why this rule existsโ€‹

Both the old experimental faster flags and the stable future.faster flags depend on the @docusaurus/faster package being installed.

Without that package declaration, the config can look valid in review while the workspace does not actually own the dependency it is enabling.

โŒ Incorrectโ€‹

export default {
future: {
faster: true,
},
};

โœ… Correctโ€‹

export default {
future: {
faster: true,
},
};

with @docusaurus/faster declared in the nearest package.json.

Behavior and migration notesโ€‹

This rule is report-only.

It does not edit package.json automatically.

When not to use itโ€‹

Do not use this rule if your repository intentionally relies on a higher-level workspace package manifest and you do not want each site workspace to declare @docusaurus/faster locally.

Rule catalog ID: R109

Further readingโ€‹