Configurable links context provider for OpenCtx

This is a context provider for OpenCtx that annotates your code with links based on configurable patterns.

Example

!Screenshot of OpenCtx docs link items in a GitHub PR

_Show relevant internal docs in GitHub PRs_

!Screenshot of OpenCtx docs link items in a code file

_Add links (in VS Code) to internal CSS guidelines to files using CSS_

Visit the OpenCtx playground for live examples.

Usage

Add the following to your settings in any OpenCtx client:

``json
"openctx.providers": {
// ...other providers...
"https://openctx.org/npm/@openctx/provider-links": {
"links": [
// Link to docs next to every literal match of eventLogger.log in *.ts files.
{
"title": "Event logging tips",
"url": "https://example.com/event-logging-docs",
"type": "docs",
"preview": true,
"path": "*/.ts",
"pattern": "eventLogger\\.log"
},

// Link to a PostgreSQL console for the specific table being queried in a code file.
{
"title": "🐘 $

// Link TODO(person) comments to that person's profile page in your internal employee directory.
{
"title": "Contact $",
"url": "https://example.com/people?q=$",
"path": "**",
"pattern": "TODO((?\\w+))"
}
]
}
},
`

See "Configuration" for documentation on configuring link patterns and presentation details.

Tips:

- If you're using VS Code, you can put the snippet above in .vscode/settings.json in the repository or workspace root to configure per-repository links.
- Play around with the links provider in realtime on the OpenCtx playground.

Configuration

`typescript
/* Settings for the links OpenCtx provider. /
interface Settings {
links?: LinkPattern[]
}

interface LinkPattern {
/* Title of the link. /
title: string

/* URL of the link. /
url: string

/* A description of the link's destination. Markdown is supported. /
description?: string

/* The type of link (if applicable), which may affect the appearance. /
type?: 'docs'

/* Glob pattern matching the file URIs to annotate. /
path: string

/**
* Regexp pattern matching the locations in a file to annotate. If undefined, it adds the link
* to the top of the file.
*
* The pattern may contain capture groups. The values of matched capture groups can be used in
* the title, url, and description fields by using:
*
* - $n for the nth capture group
* - $ for the named capture group with the given name
* - $ for the value of encodeURIComponent($), for the url field
*
* For example, if a LinkPattern has a title Hello, $1 and a pattern (alice|bob), then the
* title returned to the client would be Hello, alice for every occurrence of alice in the
* text, and likewise Hello, bob for every occurrence of bob.
*/
pattern?: string
}
``

Development

- Source code
- Docs
- License: Apache 2.0