ModCodePattern

Intelligent code consistency — zero oversight, any language, any framework.

Create a file? ModCodePattern reminds you to export it, test it, and document it. Switch a Git branch? It triggers your deployment checklist. Every morning at 9 AM? Your standup link opens automatically.

One JSON file. Infinite automation.

Why ModCodePattern?

Works with every language — JavaScript, TypeScript, Python, Java, Rust, Go, C#, PHP, Ruby, and more.

Get Started in 30 Seconds

1. Install ModCodePattern from the VS Code Marketplace

2. Create a .mod-patterns.json at your project root:

{
  "patterns": [
    {
      "onCreateFile": "src/components/**/*.tsx",
      "notify": ["src/components/index.ts"],
      "description": "📦 Export the new component"
    }
  ]
}

3. Create a new component file — a Todo task appears instantly!

Press Ctrl+Space inside .mod-patterns.json to get full auto-completion and validation powered by the built-in JSON Schema.

Features at a Glance

File System Monitoring

6 triggers to watch every move in your codebase.

Four notification types

File — Remind to update a specific file:

{
  "onChange": "src/api/**/*.ts",
  "notify": [
    { "file": "src/types/api.d.ts", "description": "📝 Update API types" }
  ]
}

Folder — Remind to work in a directory:

{
  "onCreateFile": "src/services/**/*.ts",
  "notify": [
    { "folder": "tests/services/", "description": "🧪 Add tests here" }
  ]
}

Commands — Remind to run scripts:

{
  "onChange": "src/**/*.ts",
  "notify": [
    { "commands": ["npm run lint", "npm test"], "description": "🚀 Run checks" }
  ]
}

URL (External Links) — Open a link in the browser:

{
  "onCreateFile": "src/api/**/*.ts",
  "notify": [
    { "url": "https://wiki.company.com/api-guidelines", "description": "📖 Read API guidelines" }
  ]
}

Use url notifications to link to wikis, dashboards, design specs, meeting rooms, or any external resource your team needs.

Pattern Identification

Give every pattern a unique id to reference it, debug it, and link it to others.

The id property is a unique identifier for your pattern. It is required when using Linked Tasks (triggerNext) and recommended for all patterns for clarity:

{
  "id": "component-export",
  "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
  "notify": [
    { "file": "{{COMPONENTS_DIR}}/index.ts", "description": "📦 Export {{TRIGGER_NAME}}" }
  ],
  "description": "New component → export it"
}

Pattern IDs appear in the Health Check output, workspace statistics, and the Todo list — making it easy to trace which rule generated which task.

Content Filtering

Only trigger when the file contains specific content.

Instead of reacting to every save on a file, use contentFilter to fire only when the file includes a specific string or pattern:

{
  "onChange": "src/**/*.ts",
  "contentFilter": "export default class",
  "notify": [
    { "file": "src/index.ts", "description": "📦 Update barrel export" }
  ],
  "description": "🎯 Only triggers for files with a default class export"
}

{
  "onChange": "src/api/**/*.ts",
  "contentFilter": "@deprecated",
  "notify": [
    { "file": "docs/deprecations.md", "description": "📝 Document deprecated API" }
  ],
  "description": "⚠️ Deprecated API detected"
}

This prevents noise — you only get reminders when it actually matters.

Inline Hints

See pattern reminders directly inside your source code.

When a pattern triggers, ModCodePattern can display inline hints as decorations right in the affected files — no need to open the Todo list to know what to do:

// Your code
export const Button = () => {
  return <button>Click me</button>;
};

// 📝 🔄 API modified — synchronize types     ← inline hint

Configure per pattern

Use showInlineHint to control which patterns show hints:

{
  "patterns": [
    {
      "onChange": "src/api/**/*.ts",
      "notify": [
        { "file": "src/types/api.ts", "description": "📝 Update API types" }
      ],
      "showInlineHint": true,
      "description": "🔧 API modified"
    },
    {
      "onChange": ".env",
      "notify": [
        { "file": "docker-compose.yml", "description": "🐳 Update Docker config" }
      ],
      "showInlineHint": false,
      "description": "⚙️ Env changed (silent)"
    }
  ]
}

• showInlineHint: true — (default) hints appear in the triggering file and target files
• showInlineHint: false — pattern works normally but no visual decoration in the editor

Best for: synchronization reminders, guidance for new developers, contextual notes. Disable for: high-frequency patterns that would clutter the editor.

onStart — Onboarding & Educational Trigger

Show a checklist the moment a developer opens the project.

The onStart trigger fires when the extension activates (project open) or manually via Ctrl+Shift+P → "ModCodePattern: Start". Perfect for onboarding and educational workflows:

{
  "onStart": true,
  "notify": [
    { "file": "README.md", "description": "📚 Read the project guide" },
    { "file": "docs/ARCHITECTURE.md", "description": "🏗️ Understand the architecture" },
    { "file": "docs/CODING_STANDARDS.md", "description": "📏 Review coding standards" },
    { "url": "https://company.slack.com/channels/dev-team", "description": "💬 Join the team channel" },
    { "commands": ["npm install", "npm run dev"], "description": "🚀 Setup & run" }
  ],
  "description": "👋 Welcome! Follow these steps to get started"
}

New team members open the project → the Todo list instantly shows them exactly what to do, in order. No more 20-page onboarding docs.

Chained Patterns vs Linked Tasks

ModCodePattern offers two ways to create multi-step workflows. Understanding the difference is key:

Chained Patterns — Implicit workflow

Chained patterns work implicitly: the output of Pattern A naturally matches the trigger of Pattern B. No special property needed — just smart glob alignment:

{
  "patterns": [
    {
      "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
      "notify": [
        { "file": "src/stories/{{TRIGGER_NAME}}.stories.tsx", "description": "📖 Create Storybook story" }
      ],
      "description": "Step 1 — Component created"
    },
    {
      "onCreateFile": "src/stories/**/*.stories.tsx",
      "notify": [
        { "folder": "{{TESTS_DIR}}/stories/", "description": "🧪 Create story tests" }
      ],
      "description": "Step 2 — Story created"
    },
    {
      "onCreateFile": "{{TESTS_DIR}}/stories/**/*.test.tsx",
      "notify": [
        { "commands": ["npm run test:stories"], "description": "🚀 Run story tests" }
      ],
      "description": "Step 3 — Tests created"
    }
  ]
}

How it flows: You create Button.tsx → notified to create Button.stories.tsx → you create it → notified to create tests → you create them → notified to run tests.

Each pattern triggers independently because the file you create matches the next pattern's glob. It's natural and requires no linking — but you must create each file yourself to advance the chain.

Linked Tasks (triggerNext) — Explicit workflow

Linked tasks use the triggerNext property to explicitly connect patterns by their id. When all tasks of Pattern A are completed (checked off in the Todo list), Pattern B fires automatically:

{
  "patterns": [
    {
      "id": "step-1-setup",
      "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
      "notify": [
        { "file": "{{COMPONENTS_DIR}}/index.ts", "description": "📦 Export the component" },
        { "file": "src/types/{{TRIGGER_NAME}}.types.ts", "description": "📘 Create type definitions" }
      ],
      "triggerNext": "step-2-testing",
      "description": "Step 1 — Setup component"
    },
    {
      "id": "step-2-testing",
      "onStart": true,
      "notify": [
        { "file": "{{TESTS_DIR}}/{{TRIGGER_NAME}}.test.tsx", "description": "🧪 Write unit tests" },
        { "commands": ["npm test"], "description": "🚀 Run test suite" }
      ],
      "triggerNext": "step-3-docs",
      "description": "Step 2 — Test the component"
    },
    {
      "id": "step-3-docs",
      "onStart": true,
      "notify": [
        { "file": "docs/components/{{TRIGGER_NAME}}.md", "description": "📝 Write documentation" },
        { "url": "https://storybook.myapp.com", "description": "📖 Verify in Storybook" }
      ],
      "description": "Step 3 — Document the component"
    }
  ]
}

How it flows: You create a component → Step 1 tasks appear → you complete them all ✅ → Step 2 tasks appear automatically → you complete them ✅ → Step 3 tasks appear automatically.

When to use which?

You can combine both approaches in the same project for maximum flexibility.

Adaptive Variables — Auto-detects Your Architecture

No hard-coded paths. Your patterns work across any project structure.

{
  "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
  "notify": ["{{COMPONENTS_DIR}}/index.ts"],
  "description": "📦 Export {{TRIGGER_NAME}} component"
}

Whether your components live in src/components/, app/ui/, or lib/widgets/ — the pattern just works.

Architecture variables (auto-detected)

Variable status: Run Ctrl+Shift+P → "ModCodePattern: Show Adaptive Variables" to see which variables are ✅ Found (directory exists in your project) vs ❌ Not Assigned (suggested but not yet created). Only found variables resolve in your patterns — create the missing directories to activate them automatically.

Runtime variables

Tip: Use {{TRIGGER_NAME}} (not {{TRIGGER_FILE}}) when building file paths to avoid double extensions like Button.tsx.test.tsx.

Custom variables

Define your own reusable values:

{
  "variables": {
    "COMPANY": "Acme",
    "API_VERSION": "v2",
    "DESIGN_SYSTEM": "lib/design"
  },
  "patterns": [
    {
      "onChange": "{{DESIGN_SYSTEM}}/**/*.tsx",
      "notify": [
        { "file": "docs/{{COMPANY}}/api-{{API_VERSION}}.md", "description": "📝 Update docs" }
      ]
    }
  ]
}

Custom variables can override auto-detected ones if your project uses a non-standard structure:

{
  "variables": {
    "COMPONENTS_DIR": "lib/ui",
    "TESTS_DIR": "spec"
  }
}

Variable Transformations 🔒 Premium

Transform any variable on the fly with pipe filters — 17 built-in transformations.

Apply transformations directly inside {{ }} using the pipe | syntax:

{
  "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
  "notify": [
    {
      "file": "tests/{{TRIGGER_NAME | kebabCase}}.test.tsx",
      "description": "🧪 Test for {{TRIGGER_NAME | pascalCase}}"
    }
  ]
}

If you create MyButton.tsx:

• {{TRIGGER_NAME | kebabCase}} → my-button
• {{TRIGGER_NAME | pascalCase}} → MyButton

All 17 transformations

Chain multiple transformations

{
  "file": "logs/{{TRIGGER_NAME | lowercase | replace:_:-}}.log",
  "description": "📊 Log for {{TRIGGER_NAME | uppercase | first:10}}"
}

Scheduled Reminders

Never miss a standup, a deadline, or an end-of-day commit again.

{
  "onSchedule": {
    "time": "09:00",
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"]
  },
  "notify": [
    {
      "url": "https://meet.google.com/your-standup",
      "description": "🕘 Daily standup — {{DAY_NAME_FR}} {{DATE_FORMATTED}}"
    }
  ]
}

{
  "onSchedule": {
    "time": "17:00",
    "days": "daily"
  },
  "notify": [
    {
      "commands": ["git status"],
      "description": "🕐 End-of-day commit check — {{WORKSPACE_NAME}}"
    }
  ]
}

Schedule options

Temporal variables

Free: 3 scheduled reminders  |  Premium: Unlimited

Manual Commands

Create custom "magic buttons" in the Command Palette for your most complex workflows.

Open Ctrl+Shift+P → "ModCodePattern: Run Pattern" and pick any command you defined:

{
  "onManual": "deployProduction",
  "manualTitle": "🚀 Deploy to Production",
  "description": "Full deployment checklist",
  "notify": [
    { "commands": ["npm run build", "npm test"], "description": "🔧 Build & test" },
    { "file": "CHANGELOG.md", "description": "📋 Update changelog" },
    { "url": "https://dashboard.production.com", "description": "🌐 Open monitoring" }
  ]
}

More ideas:

Free: 3 manual commands  |  Premium: Unlimited

Multilingual Descriptions

Write pattern descriptions in both English and French — ModCodePattern picks the right one based on VS Code language.

{
  "onChange": "src/api/**/*.ts",
  "notify": [
    {
      "file": "src/types/api.ts",
      "description": {
        "fr": "📘 Mettre à jour les types API",
        "en": "📘 Update API types"
      }
    }
  ],
  "description": {
    "fr": "🔧 API modifiée",
    "en": "🔧 API modified"
  }
}

Your descriptions, notifications, and Todo items will appear in the user's language automatically.

Modular Configuration

Split your patterns across multiple files for large projects. Premium

{
  "imports": [
    ".mod-patterns/react.json",
    ".mod-patterns/api.json",
    ".mod-patterns/testing.json"
  ],
  "patterns": [
    {
      "onChange": "package.json",
      "notify": ["README.md"],
      "description": "📦 Dependencies changed"
    }
  ]
}

Each imported file contains its own "patterns" array. Keep your config clean and organized by domain:

.mod-patterns/
├── react.json        ← Component patterns
├── api.json          ← API & service patterns
├── testing.json      ← Test automation patterns
└── onboarding.json   ← Developer onboarding

Git Event Automation 🔒 Premium

React to Git events in real time — branch switches, commits, pushes, and more.

Available Git triggers

Examples

Auto-deploy when switching to main:

{
  "onBranchSwitch": { "to": "main" },
  "notify": [
    {
      "commands": ["npm run build:production", "npm run deploy"],
      "description": "🚀 Deploy {{PROJECT_NAME}} to production"
    }
  ]
}

Update changelog on feature commits:

{
  "onCommit": { "message": "feat:*" },
  "notify": [
    { "file": "CHANGELOG.md", "description": "📝 Document: {{COMMIT_MESSAGE}}" }
  ]
}

Setup environment on new feature branches:

{
  "onBranchCreate": { "name": "feature/*" },
  "notify": [
    { "file": "docs/features/{{BRANCH_NAME}}.md", "description": "📝 Create feature doc" },
    { "commands": ["npm install"], "description": "📦 Install dependencies" }
  ]
}

Auto-install after pull:

{
  "onPull": { "remote": "origin", "branch": "main" },
  "notify": [
    { "commands": ["npm install"], "description": "📦 Install new dependencies" }
  ]
}

Git variables (13+)

Built-in Smart Features

JSON Auto-completion & Validation

The built-in JSON Schema gives you real-time suggestions and error checking as you type in .mod-patterns.json. Press Ctrl+Space to explore all options — triggers, notification types, variables, and properties are all documented inline.

Interactive Todo List

All pattern notifications appear as checkable tasks in a dedicated VS Code panel. Open it anytime with Ctrl+Shift+P → "ModCodePattern: Open Todo List". Tasks include clickable file links, executable commands, and openable URLs.

Health Check

Run Ctrl+Shift+P → "ModCodePattern: Run Health Check" to detect:

• Overly broad patterns (**/*.*)
• Non-existent directories referenced in patterns
• Undefined or empty variables (adaptive, custom, runtime — each verified intelligently)
• Results shown in a dedicated Output Channel

Pattern Toggle

Pause all patterns instantly with Ctrl+Shift+Alt+P (status bar shows "⏸️ Paused"), or disable individual patterns with enabled:

{
  "id": "heavy-pattern",
  "onChange": "src/**/*.ts",
  "enabled": false,
  "notify": [{ "file": "src/index.ts", "description": "📦 Update exports" }],
  "description": "Temporarily disabled"
}

• Global toggle does not affect manual commands
• enabled: false hides the pattern from manual command selection too

Silent Mode

Keep detections running in the background without popup notifications:

Settings → ModCodePattern → Silent Mode: true

The Todo list and status bar still work — you just won't be interrupted by popups.

Workspace Statistics

Run Ctrl+Shift+P → "ModCodePattern: Show Workspace Statistics" to see active patterns count, usage limits, workspace info, and variable status at a glance.

Smart Notification System

• 1st detection of a task → popup notification shown
• Repeated saves (Ctrl+S spam) → notifications silenced
• After task completion → popup re-enabled if triggered again
• The Todo list is the single source of truth — no duplicate popups

Real-World Examples

React project

{
  "patterns": [
    {
      "id": "react-component",
      "onCreateFile": "{{COMPONENTS_DIR}}/**/*.tsx",
      "notify": [
        { "file": "{{COMPONENTS_DIR}}/index.ts", "description": "📦 Export {{TRIGGER_NAME}}" },
        { "file": "src/stories/{{TRIGGER_NAME}}.stories.tsx", "description": "📖 Create Storybook story" },
        { "folder": "{{TESTS_DIR}}/components/", "description": "🧪 Add unit tests" }
      ],
      "showInlineHint": true,
      "description": "New React component"
    }
  ]
}

API + Documentation

{
  "id": "api-sync",
  "onChange": "src/api/**/*.ts",
  "contentFilter": "export",
  "notify": [
    { "file": "src/types/api.d.ts", "description": "📝 Update API types" },
    { "file": "docs/api/{{TRIGGER_NAME}}.md", "description": "📖 Update API docs" },
    { "file": "tests/api/{{TRIGGER_NAME}}.test.ts", "description": "🧪 Update tests" }
  ],
  "description": "🔧 API endpoint modified"
}

Full onboarding workflow (Linked Tasks)

{
  "patterns": [
    {
      "id": "onboarding-step-1",
      "onStart": true,
      "notify": [
        { "file": "README.md", "description": "📚 Read the project guide" },
        { "file": "docs/ARCHITECTURE.md", "description": "🏗️ Understand the architecture" }
      ],
      "triggerNext": "onboarding-step-2",
      "description": "👋 Step 1 — Read the docs"
    },
    {
      "id": "onboarding-step-2",
      "onStart": true,
      "notify": [
        { "commands": ["npm install"], "description": "📦 Install dependencies" },
        { "commands": ["npm run dev"], "description": "🚀 Start dev server" }
      ],
      "triggerNext": "onboarding-step-3",
      "description": "⚙️ Step 2 — Setup environment"
    },
    {
      "id": "onboarding-step-3",
      "onStart": true,
      "notify": [
        { "url": "https://company.slack.com/channels/dev-team", "description": "💬 Join the team channel" },
        { "file": "docs/CODING_STANDARDS.md", "description": "📏 Review coding standards" }
      ],
      "description": "🤝 Step 3 — Join the team"
    }
  ]
}

Multi-language project

{
  "onChange": "src/**/*.{py,java,rs,go}",
  "notify": [
    { "file": "tests/test_{{TRIGGER_NAME}}.{py,java,rs,go}", "description": "🧪 Update tests" }
  ],
  "description": "🔧 Source file modified"
}

Combined workflow (Chained + Git + Schedule + Manual)

{
  "patterns": [
    {
      "onBranchCreate": { "name": "feature/*" },
      "notify": [
        { "file": "docs/features/{{BRANCH_SUFFIX}}.md", "description": "📝 Document feature" }
      ],
      "description": "🌱 New feature branch"
    },
    {
      "onSchedule": { "time": "09:00", "days": ["monday", "wednesday", "friday"] },
      "notify": [
        { "url": "https://meet.google.com/standup", "description": "🕘 Standup — {{DAY_NAME_FR}}" }
      ]
    },
    {
      "onManual": "release",
      "manualTitle": "🚀 Release Checklist",
      "notify": [
        { "commands": ["npm test", "npm run build"], "description": "✅ Validate" },
        { "file": "CHANGELOG.md", "description": "📋 Update changelog" },
        { "commands": ["npm version patch"], "description": "🔖 Bump version" }
      ]
    }
  ]
}

Ready-to-Use Pattern Library

Skip the setup — grab pre-built, tested patterns for your stack:

React · Vue.js · Angular · Node.js · TypeScript · Python · and more

Browse the Pattern Library →

Free vs Premium

Free — Perfect to get started

• 5 file-monitoring patterns
• 3 scheduled reminders
• 3 manual commands
• Full adaptive, runtime & custom variables
• 4 notification types (file, folder, command, URL)
• Chained patterns & linked tasks (triggerNext)
• Inline hints, content filtering, pattern identification
• Interactive Todo list, JSON schema, multilingual support
• onStart trigger, pattern toggle, silent mode
• Health check & workspace statistics

Premium — $6/month · For teams and power users

Everything in Free, plus:

• Unlimited patterns, reminders, and manual commands
• 17 variable transformations — {{NAME | camelCase}}, {{PATH | basename}}, {{NAME | replace:old:new}}
• Git event automation — branch, commit, pull, push triggers
• 13+ Git dynamic variables — {{BRANCH_NAME}}, {{COMMIT_MESSAGE}}, etc.
• Modular configuration — split patterns across files with imports
• Priority support
• 14-day free trial

Upgrade to Premium →

All Commands

Resources

• Complete Documentation — Full interactive guide with all features
• Pattern Library — Ready-to-use patterns by technology
• Pattern Builder — Visual pattern generator
• French Documentation — Guide utilisateur complet en français

Current version: v0.4.0  |  Engine: VS Code 1.74.0+  |  Startup: < 200ms  |  License: MIT

Made with precision for developers who care about consistency.