npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@openctx/provider-links

v0.0.20

Published

Add links to your code based on configurable patterns (OpenCtx provider)

Downloads

423

Readme

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:

"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": "🐘 $<table> table (PostgreSQL console)",
                "url": "https://example.com/postgresql?table=$<table|queryEscape>",
                "description": "View table schema and data...",
                "path": "**",
                "pattern": "(FROM|UPDATE|INSERT INTO|DELETE FROM|ALTER TABLE) (?<table>\\w+)"
            },

            // Link TODO(person) comments to that person's profile page in your internal employee directory.
            {
                "title": "Contact $<person>",
                "url": "https://example.com/people?q=$<person|queryEscape>",
                "path": "**",
                "pattern": "TODO((?<person>\\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

/** 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
   * - $<name> for the named capture group with the given name
   * - $<name|queryEscape> for the value of encodeURIComponent($<name>), 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