Skip to main content

eslint-plugin-repo

eslint-plugin-repo helps repositories enforce provider-specific governance and hygiene files.

:::tip What should I read first?

:::

What this documentation includes​

  • A complete rule reference for repository-file and provider compliance checks.
  • Getting Started guidance for Flat Config projects.
  • Preset docs for GitHub, GitLab, Bitbucket, Codeberg/Forgejo, AWS, Azure, Google Cloud, Docker, Vercel, Netlify, and DigitalOcean.
  • A dedicated developer section with architecture notes, ADRs, and docs pipeline guidance.

What to read first​

  1. Open Getting Started to install the plugin and enable your first preset.
  2. Review Rule Overview to understand rule categories and naming.
  3. Visit the Developer Guide if you are maintaining rules, docs, or release workflows.

Choose your route​

I want to lint one repository host well​

I want to understand the rule catalog​

  • Browse the Rules overview.
  • Use the provider categories in the rules sidebar to narrow the list quickly.
  • Read preset pages before enabling large groups of rules blindly.

I maintain the plugin or docs​

Documentation map​

  • Rule docs (/docs/rules/**): End-user reference and preset usage.
  • Site docs (/docs/**): Developer-facing architecture, lifecycle docs, and operational guides.
  • Blog (/blog/**): Maintainer commentary and migration stories.
GoalBest starting point
Install the pluginGetting Started
Compare preset scopehttps://nick2bad4u.github.io/eslint-plugin-repo/docs/rules/presets
Read provider-specific ruleshttps://nick2bad4u.github.io/eslint-plugin-repo/docs/rules/overview
Understand docs generationDeveloper Guide

Next step​

Open the Getting Started page in the sidebar and enable your first preset.