Skip to main content

Getting Started

Use this path for predictable adoption:

  1. baseline policy checks,
  2. provider-specific presets,
  3. optional strict hardening.

If you are new, read Overview first and keep Presets open while configuring.

1) Install​

npm install --save-dev eslint-plugin-repo typescript

2) Enable baseline coverage​

import repoPlugin from "eslint-plugin-repo";

export default [repoPlugin.configs.recommended];

recommended gives you repository baseline policy checks. See recommended preset details.

Common first rules you will see from this baseline include require-readme-file, require-license-file, and require-security-policy-file.

3) Add the provider preset you actually use​

Example layering:

import repoPlugin from "eslint-plugin-repo";

export default [
  repoPlugin.configs.recommended,
  repoPlugin.configs.github,
];

4) Optional stricter profile​

  • repoPlugin.configs.strict: adds stricter policy checks on top of baseline (details).
  • repoPlugin.configs.all: enables all rules in the plugin (details).

5) Verify and explore​

Next reads by scenario​