https://github.com/qltysh/qlty-browser
🌐 Bring code coverage data directly onto GitHub with the Qlty extension for Chrome and Firefox
https://github.com/qltysh/qlty-browser
Last synced: 7 months ago
JSON representation
🌐 Bring code coverage data directly onto GitHub with the Qlty extension for Chrome and Firefox
- Host: GitHub
- URL: https://github.com/qltysh/qlty-browser
- Owner: qltysh
- License: other
- Created: 2025-04-05T18:01:44.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-06-19T19:12:19.000Z (7 months ago)
- Last Synced: 2025-06-19T20:26:19.145Z (7 months ago)
- Language: TypeScript
- Homepage: https://qlty.sh
- Size: 242 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Qlty Browser Extension
A cross-browser extension for the [Qlty](https://qlty.sh) platform that provides
code quality insights directly in GitHub pull requests and commits. The extension
supports both Chrome and Firefox using a unified codebase.
## Supported Browsers
- **Chrome** - Uses Manifest v3 with service workers
- **Firefox** - Uses Manifest v2 with background scripts
## Development
### Installing Dependencies
```sh
npm install
```
### Building
For development with file watching:
```sh
# Chrome (default)
npm run watch
# Chrome specifically
npm run watch:chrome
# Firefox
npm run watch:firefox
```
For production builds:
```sh
# Chrome (default)
npm run build
# Chrome specifically
npm run build:chrome
# Firefox
npm run build:firefox
```
All builds output to the `dist/{chrome,firefox}` directories respectively.
### Loading the Extension
#### Chrome
1. Build the extension: `npm run build:chrome` or `npm run watch:chrome`
2. Go to `chrome://extensions`
3. Enable "Developer mode"
4. Click "Load unpacked"
5. Select the `dist/chrome` folder from the repository
For more details, see the [Chrome Extension Developer Documentation][chrome-ext-load].
#### Firefox
1. Build the extension: `npm run build:firefox` or `npm run watch:firefox`
2. Run `npm run run:firefox` to load the extension in Firefox.
The extension automatically rebuilds when source files change during development,
but you'll need to reload the extension in the browser to see changes.
## Architecture
For technical details about the extension's architecture, cross-browser compatibility, and implementation details, see [ARCHITECTURE.md](ARCHITECTURE.md).
[chrome-ext-load]: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked