@donedeal0/codefather

WHAT IS IT?

Codefather protects your codebase by controlling who can change what. Set authorization levels, lock down files, and enforce your rules—offline via CLI or online with GitHub Actions.

ℹ️ The documentation is also available on our website!

FEATURES

FEATURE	CODEFATHER	GITHUB CODEOWNERS
Files and folders protection	✅	✅
Github Action	✅	✅
Auto-assign reviewers	✅	✅
Supports teams	✅	✅
CLI + pre-commit	✅	❌
Roles hierarchy	✅	❌
Custom messages	✅	❌
Godfather vibe	✅	❌

SCREENSHOTS

INSTALLATION

npm install @donedeal0/codefather --save-dev

USAGE

Codefather has 4 commands:

# checks if your access rules are respected in your repository
codefather 

# creates a default config.ts at the root of your repository and add a `codefather` command to your package.json
codefather-init 

# creates a default config.json at the root of your repository and add a `codefather` command to your package.json
codefather-init -- --json

# similar to the `codefather` command, but works in a Github Action environment
codefather-github

You can either add a script shortcut in your package.json (recommended):

"scripts": {
  "codefather": "codefather",
}

Or directly run the commands with npx:

npx codefather
npx codefather-init

CONFIG

At the root of your repository, add a codefather.ts or codefather.json file.

import type { CodefatherConfig } from "@donedeal0/codefather";

export default {
  caporegimes: [
    { name: "solozzo" },
    { name: "@lucabrasi", emailPrefix: "luca.brasi" },
  ],
  rules: [
    {
      match: ["package.json", "src/core/**", /^src\/app\/.*\.css$/],
      goodfellas: [
        { name: "solozzo" },
        { name: "@tomhagen", emailPrefix: "tom.hagen" },
      ],
      crews: ["clemenzaPeople"],
      allowForgiveness: false,
    },
    {
      match: ["src/models/**"],
      goodfellas: [
        { name: "mike", emailPrefix: "michael.corleone" },
        { name: "sonny", emailPrefix: "sonny" },
      ],
      allowForgiveness: true,
      message: "Custom message to tell you to NOT TOUCH THE MODELS!",
    },
  ],
  options: {
    showAscii: true,
    vouchForAllCommitters: true,
  },
  codeReviews: {
    autoAssignGoodfellas: true,
    autoAssignCaporegimes: true,
  },
  crews: {
    clemenzaPeople: [{ name: "@paulieGatto" }, { name: "@lucabrasi" }],
  },
} satisfies CodefatherConfig;

⚙️ Here's how it works.

The CodefatherConfig allows you to control which users can modify parts of your codebase, and to refine the behavior of codefather.

type CodefatherConfig {
  /** List of users authorized to modify any files in your repository.
   * name: github username.
   * emailPrefix: prefix of the user email tied to their Github account (e.g. [e-mail] should be johnny.fontane).
   */
  caporegimes?: GitUser[];
  /** Rules that apply to protected files and folders */
  rules: CodefatherRule[];
  /** Options to refine the output */
  options?: {
    /** If true, the codefather face will appear in the terminal. Defaults to true. */
    showAscii?: boolean;
    /** If true, all the pull request committers will be checked against the authorized users. Only used in a GitHub Action context. Defaults to true. */
    vouchForAllCommitters?: boolean;
  };
  /** Options to auto assign reviewers on Github */
  codeReviews?: {
    /** If true, goodfellas responsible for modified files will be assigned on relevant pull requests, except the committers. Defaults to true. */
    autoAssignGoodfellas: boolean;
    /** If true, caporegimes will be assigned on every pull request except the committers. Defaults to false. */
    autoAssignCaporegimes: boolean;
  };
  /** Group users into teams. Crew names and composition are flexible in CLI mode but should match your github teams if used in a Github Action */
  crews?: Record<CrewName, GitUser[]>;
}

A Rule defines which users can change a set of files.

type CodefatherRule {
  /** List of the files or folders that can only be modified by a given list of users */
  match: Array<RegExp | string>;
  /** List of users authorized to modify the list of files or folders.
   * name: github username.
   * emailPrefix: prefix of the user email tied to their Github account (e.g. [e-mail] should be johnny.fontane) .
   */
  goodfellas: GitUser[];
  /** List of authorized user crews. The crews must be defined at the root of your config when used in CLI mode. */
  crews?: CrewName[];
  /** The message displayed if an unauthorized user tries to modify a protected file. If empty, a random message will be generated. */
  message?: string;
  /** If true, a warning will be issued and the script will not throw an error. False by default. */
  allowForgiveness?: boolean;
}

A GitUser is a developer in your codebase:

type GitUser = {
  name?: string;
  emailPrefix?: string;
};

You can use either the name, the email, or both, depending on your preference. The name should match your GitHub username (e.g. @tom.hagen). If you prefer the email, it should also be tied to your Github account.

For security reasons, only the email prefix is allowed in your config (e.g. [e-mail] should be johnny.fontane).

In CLI mode, the name and email are retrieved from your Git config. You can set them like this:

 git config --global user.username "DonCorleone"
 git config --global user.email "[e-mail]"

You can verify the current values like this:

git config user.username # return DonCorleone
git config user.email # return [e-mail]

In a Github Action, codefather will use Github's API, so you don't have to worry about the git config.

A CrewName is the name of a developers team

type CrewName = string;

GITHUB ACTION

Add this code in your .github/workflows/codefather.yml (the file name is up to you). The GITHUB_TOKEN will be automatically injected by Github.

name: Codefather Validation
on:
  pull_request:
    branches: [main]

permissions:
  contents: read
  pull-requests: write

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - name: Install dependencies
        run: npm install

      - name: Run Codefather
        run: npx codefather-github
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

🛡️ ENFORCE REVIEWS

To enforce reviews from codeowners (goodfellas, caporegimes and crews), consider enabling branch protection in your repository settings. To do it:

• Go to settings
• Click on Brancheson the left sidebar
• Select Add classic branch protection rule
• Check
  • Require a pull request before merging
  • Require approvals
• You're now under the protection of the Codefather.

GLOSSARY

Codefather uses the Godfather's lingo. Although you don't need to know it to use the library, here are the definition of the special words used in the config file:

• caporegime: a captain who leads a group of mafia members. It's a tech-lead.
• goodfella: an appellation for a mobster (like "wise-guy" or "made man"). It's a developer.

CODEFATHER VIBE

We believe open source libraries should be both useful and entertaining. The Don will amuse you with over 100 personalized reactions to your commits—whether you trespassed the rules, flirted with the limits, or respected the codebase like an honorable developer.

This being said, if you don't like the gangster movie atmosphere and still want to use codefather, you can absolutely opt-out by providing your own custom messages and hiding the Don's face in the terminal.

CREDITS

DoneDeal0 | talk.donedeal0[at]gmail.com

SUPPORT

If you or your company uses Codefather, please show your support by becoming a sponsor! Your name and company logo will be displayed on the README.md.

Premium support is also available. https://github.com/sponsors/DoneDeal0

CONTRIBUTING

Issues and pull requests are welcome!