https://github.com/anilonayy/jira-issue-linker

A Visual Studio Code extension that links JIRA issues in code to their corresponding issues in JIRA.
https://github.com/anilonayy/jira-issue-linker

jira jira-rest-api vscode vscode-extension

Last synced: about 2 months ago
JSON representation

A Visual Studio Code extension that links JIRA issues in code to their corresponding issues in JIRA.

• Host: GitHub
• URL: https://github.com/anilonayy/jira-issue-linker
• Owner: anilonayy
• License: mit
• Created: 2024-12-01T14:19:07.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-12-11T20:00:21.000Z (5 months ago)
• Last Synced: 2025-01-30T11:44:12.858Z (4 months ago)
• Topics: jira, jira-rest-api, vscode, vscode-extension
• Language: JavaScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=anilonayy.jira-issue-linker
• Size: 298 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
## Jira Issue Linker - README

![Visual Studio Marketplace Installs - Azure DevOps Extension](https://img.shields.io/visual-studio-marketplace/azure-devops/installs/total/anilonayy.jira-issue-linker)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/anilonayy/jira-issue-linker)

![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/anilonayy.jira-issue-linker)

Overview

The Jira Issue Linker is a VS Code extension that makes JIRA task keys (e.g., PROJ-123) in your code clickable. When clicked, these keys open the corresponding JIRA task in your browser. Additionally, hovering over a task key provides useful details about the task, such as its status, assigned developer, QA, and completion date.

## Usage

![image](assets/presentation.gif)

## Configurations

To use the extension, you need to configure your JIRA credentials and fields in your VS Code settings.

- Open Settings `(Ctrl + , or Cmd + ,)`.

Example configuration in `settings.json`:

```json

{   

  "jiraIssueLinker.jiraBaseURL": "https://yourcompany.atlassian.net",

  "jiraIssueLinker.jiraToken": "dXNlcm5hbWU6YXBpX3Rva2Vu",

  "jiraIssueLinker.jiraFields": {

    "developer": "customfield_1",

    "qa": "customfield_2",

    "completeDate": "customfield_3"

  }

}

```

## Features

- Clickable Task Keys: Click or Ctrl/Command + Click on any JIRA task key to open it in your browser.

- Hover Information: View task details (e.g., status, developer, QA, and completion date) by hovering over the task key.

- Task Caching: Reduces API requests by caching task data for 5 minutes.

- Customizable Fields: Configure which JIRA fields to display in hover information.

- Dynamic Decorations: Highlights JIRA task keys in your code with an underline and blue text.

## How to Use

- Open a file in VS Code.

- Write or paste a JIRA task key (e.g., PROJ-123) in your code.

- Hover over the task key to view details.

- Click or `Ctrl/Command + Click` on the task key to open it in your browser.