diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e1ad253 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# macOS +.DS_Store + +# Dependency directories +node_modules/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..7fea7fb --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Azure DevOps PR Syntax Highlighter + +A browser extension that brings syntax highlighting to file diffs in Azure DevOps pull requests, making code reviews easier and more efficient. + +## Features + +- **Syntax Highlighting:** Automatically applies syntax highlighting to code in pull request diffs. +- **Language Detection:** Detects the programming language based on file extensions. +- **Theme Support:** Seamlessly integrates with both light and dark themes in Azure DevOps. +- **Powered by Prism:** Utilizes the popular [Prism](https://prismjs.com/) library for fast and accurate highlighting. + +## Screenshots + +### Before & After + +![Before and After](assets/screenshots/before-after-1280-800.png) + +### Side-by-side Diff + +![Side-by-side Diff](assets/screenshots/side-by-side-1280-800.png) + +### Inline Diff + +![Inline Diff](assets/screenshots/inline-1280-800.png) + +## Installation + +### From the Chrome Web Store (Recommended) + +[Available in the Chrome Web Store](https://chromewebstore.google.com/detail/azure-devops-pr-syntax-hi/lclohacjbfchomeeopaffkedfnbjicdn) + +### Manual Installation + +1. Download or clone this repository. +2. Open Google Chrome and navigate to `chrome://extensions`. +3. Enable "Developer mode" in the top right corner. +4. Click "Load unpacked" and select the directory where you downloaded the repository. + +## Usage + +Once installed, the extension will automatically apply syntax highlighting to files in any Azure DevOps pull request you view. There are no additional steps required. + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/icons/icon128.png b/assets/icons/icon128.png similarity index 100% rename from icons/icon128.png rename to assets/icons/icon128.png diff --git a/icons/icon16.png b/assets/icons/icon16.png similarity index 100% rename from icons/icon16.png rename to assets/icons/icon16.png diff --git a/icons/icon32.png b/assets/icons/icon32.png similarity index 100% rename from icons/icon32.png rename to assets/icons/icon32.png diff --git a/icons/icon48.png b/assets/icons/icon48.png similarity index 100% rename from icons/icon48.png rename to assets/icons/icon48.png diff --git a/assets/screenshots/before-after-1280-800.png b/assets/screenshots/before-after-1280-800.png new file mode 100644 index 0000000..36f1f4c Binary files /dev/null and b/assets/screenshots/before-after-1280-800.png differ diff --git a/assets/screenshots/inline-1280-800.png b/assets/screenshots/inline-1280-800.png new file mode 100644 index 0000000..7ea5d59 Binary files /dev/null and b/assets/screenshots/inline-1280-800.png differ diff --git a/assets/screenshots/side-by-side-1280-800.png b/assets/screenshots/side-by-side-1280-800.png new file mode 100644 index 0000000..607a5f6 Binary files /dev/null and b/assets/screenshots/side-by-side-1280-800.png differ diff --git a/manifest.json b/manifest.json index 2daad95..b34f38a 100644 --- a/manifest.json +++ b/manifest.json @@ -1,13 +1,14 @@ { + "$schema": "https://json.schemastore.org/chrome-manifest", "manifest_version": 3, "name": "Azure DevOps PR Syntax Highlighter", "version": "0.1.0", "description": "Adds syntax highlighting to partial file diffs in Azure DevOps Pull Requests.", "icons": { - "16": "icons/icon16.png", - "32": "icons/icon32.png", - "48": "icons/icon48.png", - "128": "icons/icon128.png" + "16": "assets/icons/icon16.png", + "32": "assets/icons/icon32.png", + "48": "assets/icons/icon48.png", + "128": "assets/icons/icon128.png" }, "host_permissions": [ "*://*.dev.azure.com/*",