Skip to content

supernalintelligence/repotype

Repository files navigation

Repotype

CI repotype validation npm License: MIT docs

Linting for your entire repository. Not just code.

ESLint checks your code. Prettier formats it. Repotype checks your repository structure — folders, file naming, schemas, frontmatter, and documentation standards.

📖 Read the Documentation →

Install

npm install -g repotype
# or
npx repotype validate .

Quick Start

# Initialize config
repotype init .

# Validate
repotype validate .

# Auto-fix issues
repotype fix .

# Generate report
repotype report . --output report.md

What It Validates

  • 📁 Folder structure — required directories, allowlists, path patterns
  • 📋 File standards — naming conventions, companion files, JSON/YAML schemas
  • 📝 Documentation — frontmatter schemas, required sections, template detection
  • 🔒 Content policies — forbidden patterns, secret detection

Example Config

# repotype.yaml
version: "1"

defaults:
  unmatchedFiles: deny  # Strict mode

folders:
  - id: src-structure
    path: src
    requiredFolders: [components, hooks, utils]
    pathCase: kebab

files:
  - id: typescript
    glob: "src/**/*.ts"
    pathCase: kebab
    
  - id: docs
    glob: "docs/**/*.md"
    frontmatter:
      required: [title, description]

Documentation

Guide Description
Getting Started Installation and first steps
Configuration Full config reference
Folder Rules Control directory structure
File Rules Validate files by pattern
CI Integration GitHub Actions, GitLab CI
CLI Reference All commands

CLI Commands

repotype init [target]           # Create repotype.yaml
repotype validate [target]       # Validate repository
repotype fix [target]            # Auto-fix violations
repotype report [target]         # Generate compliance report
repotype explain <file>          # Explain rules for a file
repotype status [target]         # Show operations status
repotype apply [target]          # Apply hooks/watcher config
repotype install-checks          # Install git hooks

CI Integration

# .github/workflows/repotype.yml
name: Repotype
on: [push, pull_request]
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npx repotype validate . --json

Share with Agents

Repotype is designed for human + agent teams. Add this to your agent instructions:

Use repotype validate . before committing. Run repotype fix . to auto-fix issues. Check repotype.yaml for repository standards.

License

MIT — Supernal Intelligence


Built to Help Fight Entropy with ♥ from Supernal Intelligence