Snyk Sourcegraph extension

⚠️ Deprecation notice

Sourcegraph extensions have been deprecated with the September 2022 Sourcegraph release. Learn more.

The repo and the docs below are kept to support older Sourcegraph versions.

Description

Provides code insights from Snyk reports.

Status: beta

Code Insight

Notification + Panel View

Configuration

The extension can be configured through JSON in user, organization or global settings.

{
  // A Snyk API token.
  "snyk.apiToken": "...",

  // Whether to show notifications when Snyk has found issues in the currently viewed project
  "snyk.showNotifications": true,

  // The Snyk extension needs to map the repository on Sourcegraph to a project inside an organization on
  // Snyk. The default settings work for most projects on Snyk, but if you have a custom setup, you
  // can configure the following settings.

  // This regular expression is matched on the repository name. The values from the capture groups are
  // available in the templates below.
  "snyk.repositoryNamePattern": "(?:^|/)([^/]+)/([^/]+)$",
  // This template is used to form the Snyk organization key.
  // By default, the second-last part of the repository name (first capture group above) is used as-is.
  // E.g. "apache" from "github.com/apache/struts".
  "snyk.organizationKeyTemplate": "$1",

  // CORS headers are necessary for the extension to fetch data, but Snyk does not send them by default.
  // Here you can customize the URL to an HTTP proxy that adds CORS headers.
  // By default Sourcegraph's CORS proxy is used.
  "snyk.corsAnywhereUrl": "https://cors-anywhere.sgdev.org"
}