prettier-plugin-codeowners

A Prettier plugin that formats CODEOWNERS files.

Install

npm install -D prettier prettier-plugin-codeowners

Usage

The plugin auto-detects files named CODEOWNERS regardless of directory (.github/CODEOWNERS, docs/CODEOWNERS, etc.).

CLI

# format in place
prettier --write .github/CODEOWNERS --plugin=prettier-plugin-codeowners

# check formatting without writing
prettier --check .github/CODEOWNERS --plugin=prettier-plugin-codeowners

Configuration file

Add the plugin to your prettier config and it applies to every CODEOWNERS file prettier encounters. No --plugin flag needed after this.

{
  "plugins": ["prettier-plugin-codeowners"]
}

Then just:

prettier --write .github/CODEOWNERS

API

import * as prettier from "prettier";

const formatted = await prettier.format(source, {
  parser: "codeowners",
  plugins: ["prettier-plugin-codeowners"],
});

Formatting rules

Owner column alignment

Patterns within a section are padded so all owners start at the same column. Each section (separated by blank lines) computes its own column width.

# before                              # after
*       @owner1                       *            @owner1
*.js         @owner2                  *.js         @owner2
/build/logs/    @owner3               /build/logs/ @owner3

Owner sorting

Owners on each line are sorted alphabetically (case-insensitive). Rule order is never changed since the last matching pattern wins in CODEOWNERS.

# before                              # after
*.js @zack @alice @bob                *.js @alice @bob @zack

No-owner lines

Lines with a pattern but no owners (used to clear ownership) are left as bare patterns without padding.

# before                              # after
/apps/    @octocat                    /apps/          @octocat
/apps/github                          /apps/github
/apps/internal/    @admin             /apps/internal/ @admin

Inline comments

Inline comments are preserved. Spacing after # is normalized. A bare trailing # with no text is dropped.

# before                              # after
*.js @owner #No space after hash      *.js @owner # No space after hash
*.rs @owner #                         *.rs @owner

Blank lines

Consecutive blank lines collapse to one. Leading and trailing blank lines are stripped.

Whitespace

Tabs and extra spaces between tokens are normalized to single spaces. Trailing whitespace is removed. Indented comment lines are de-indented. A trailing newline is always ensured.

Releasing

npm version patch  # or minor, major
git push --follow-tags

Pushing a v* tag triggers the publish workflow, which runs tests, publishes to npm via OIDC, and creates a GitHub release.

Editor setup

License

MIT