https://github.com/bagtoad/zendesk-link-collector

A browser extension to aggregate links (and attachments) in a Zendesk ticket based on user-defined RegEx patterns.
https://github.com/bagtoad/zendesk-link-collector

Last synced: 9 months ago
JSON representation

A browser extension to aggregate links (and attachments) in a Zendesk ticket based on user-defined RegEx patterns.

• Host: GitHub
• URL: https://github.com/bagtoad/zendesk-link-collector
• Owner: BagToad
• License: agpl-3.0
• Created: 2023-08-04T21:27:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-02T19:51:01.000Z (about 2 years ago)
• Last Synced: 2024-06-02T21:25:11.635Z (about 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 336 KB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Zendesk Link Collector 

This is a browser extension that collects links from a Zendesk ticket according to custom Regular Expression (regex) values. This tool's purpose is to help Zendesk users more easily handle _long_ tickets where links and/or attachments are key information.

## Installation

This extension can be installed from the [Firefox addons store](https://addons.mozilla.org/en-CA/firefox/addon/zendesk-link-collector/) or the [Chrome web store](https://chrome.google.com/webstore/detail/zendesk-link-collector/nckhapficnbbmcpapjnnegpagfcbjpja).

[![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/nckhapficnbbmcpapjnnegpagfcbjpja?logo=Google%20Chrome)](https://chrome.google.com/webstore/detail/zendesk-link-collector/nckhapficnbbmcpapjnnegpagfcbjpja) [![Mozilla Add-on Version](https://img.shields.io/amo/v/zendesk-link-collector?logo=Firefox)](https://addons.mozilla.org/en-CA/firefox/addon/zendesk-link-collector/)

You can also manually [install it from the source code](#chrome-manual-installation).

## Configuration

Access the configuration page to set link regex patterns you would like to aggregate from tickets.

Some default link patterns will be available when you install the extension. You can also download [a sample JSON file containing the default patterns](./samples/link-patterns.json) to import from the configuration page.

### Google Chrome and Firefox

Click the ⚙️ icon in the top-right corner of the extension popup to open the configuration page.

![options-button](samples/options-button-sample.png)

## Features

### Link Aggregation

- Links are aggregated according to custom regex patterns.

- No other chaos from the ticket is included in the link, only actual links are considered (`a` anchor elements).

    - Links can optionally display "context" when the "Show context?" checkbox option selected. This shows the surrounding text beside the link (the context is the parent HTML element of the `a` element).  

- Scroll to a link's source comment by clicking the spyglass icon (🔍) beside a link.

![image](samples/links-sample.png)

### Attachment Aggregation

- Attachments are aggregated.

- Scroll to an attachment's source comment by clicking the spyglass icon beside a link.

![image](samples/attachments-sample.png)

### Chrome Manual Installation

1.  Clone the repository or download and extract the ZIP file to your local machine.

2.  Open `chrome://extensions` in your Google Chrome browser.

3.  Turn on `Developer mode` by clicking the toggle in the top-right corner.

4.  Click on the `Load unpacked` button and select the `src` folder in the directory containing the extracted ZIP file.

## Project Strucutre

The project is structured like a typical manifest v3 browser extension, with some slight differences. For example, we have separate browser-specific manifest files and a `makefile` to build for each target browser.

Below is a diagram of the project using [`githubocto/repo-visualizer`](https://github.com/githubocto/repo-visualizer/).

![Visualization of the codebase](./diagram.svg)