Skip to main content

Developer docs

This section is for contributors and maintainers working on eslint-plugin-file-progress-2 itself.

Quick navigationโ€‹

Maintainer focus areasโ€‹

  • Release management: Manual npm + GitHub releases are handled from the Release workflow.
  • Rule behavior: The plugin exposes three runtime rules with rule-option-based configuration and seven presets.
  • Docs maintenance: Rule docs are written by hand under docs/rules, while API docs are generated from TypeScript with TypeDoc.
  • CLI ergonomics: Most debugging is about ESLint CLI resolution, terminal output behavior, and cross-platform path formatting.

Section mapโ€‹

  • Release Workflow: How to publish a version without Changesets.
  • CLI Debugging: How to inspect the effective config and troubleshoot terminal behavior.
  • Docs & API Workflow: Where the Docusaurus and TypeDoc sources live and how they are generated.
  • API Reference: Generated documentation for src/index.ts, src/types.ts, and src/rules/progress.ts.

API referenceโ€‹

The API section is generated by TypeDoc from the plugin source files:

  • src/index.ts
  • src/types.ts
  • src/rules/progress.ts

To regenerate it locally:

npm run docs:api

From the repository root, you can also run:

npm run docs:build

That command regenerates the API markdown and then builds the Docusaurus site.