Repository navigation
Development
Mohammad Amanalikhani edited this page Aug 27, 2026
·
1 revision
# 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 watchGitCommitMessageEditor-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
| 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 |
- Open the project in VS Code
- Press
F5to launch an Extension Development Host - Open a Git repository
- Open the editor via the Source Control panel or Command Palette
npm run package
code --install-extension GitCommitMessageEditor-vsce-*.vsixThis project is licensed under the MIT License – see the LICENSE file for details.
Contributions are welcome!
- Report bugs or request features via GitHub Issues
- Submit pull requests to the main repository
Please make sure your code passes the existing TypeScript checks and follows the project's code style.
- Maintainer: Mohammad Amanalikhani
- GitHub: idmdakhi
- Email: md.akhi.ir@gmail.com
For quick questions, you can also open a discussion in the GitHub Discussions (if enabled) or create an issue.
This extension was built using the following open-source tools and libraries:
- TypeScript – type-safe JavaScript
- esbuild – fast bundler
- VS Code API – extension framework
-
YAML – for parsing
.commit-message-editor.yamlfiles
Special thanks to the developers of the original three extensions that inspired this project:
- phoihos for the IntelliSense concepts
- Bandra for the configurable form approach
- (Add any other relevant contributors here)
Current version: 1.0.0
See the CHANGELOG for release history.