Skip to content

Development

Mohammad Amanalikhani edited this page Aug 27, 2026 · 1 revision

Development

Building from Source

# Clone the repository
git clone https://github.com/idmdakhi/GitCommitMessageEditor-vsce.git
cd GitCommitMessageEditor-vsce

# Install dependencies
npm install

# Compile
npm run compile

# Watch mode (for development)
npm run watch

Project Structure

GitCommitMessageEditor-vsce/
├── assets/              # Webview assets (CSS, JS)
├── docs/                # Documentation
├── schemas/             # JSON Schema for templates
├── src/
│   ├── config/          # Config management
│   │   ├── configManager.ts
│   │   ├── defaultConfig.ts
│   │   ├── projectConfig.ts
│   │   └── types.ts
│   ├── panels/          # Webview panels
│   │   ├── CommitEditorPanel.ts
│   │   └── ConfigEditorPanel.ts
│   ├── utils/           # Utilities
│   │   └── git.ts
│   └── extension.ts     # Extension entry point
├── templates/           # Built-in templates
│   ├── angular.json
│   ├── default.json
│   ├── gitmoji.json
│   └── text.json
├── esbuild.js           # Build configuration
├── package.json
└── tsconfig.json

Commands

Command Description
npm run compile Compiles the extension
npm run watch Compiles in watch mode
npm run package Creates a .vsix package
npm run check-types Runs TypeScript type checking

Debugging

  1. Open the project in VS Code
  2. Press F5 to launch an Extension Development Host
  3. Open a Git repository
  4. Open the editor via the Source Control panel or Command Palette

Publishing

npm run package
code --install-extension GitCommitMessageEditor-vsce-*.vsix

📚 Git Commit Message Editor

🚀 Getting Started

⚙️ Configuration

📝 Templates

💻 Development

❓ Support


🔗 External Links

Clone this wiki locally