Glossary

This glossary contains information on phrases and abbreviations used by DeepSource.

Analyzer

An analyzer operates on source code to detect issues and report metrics. Analyzers can be focused on a programming language, like the Python analyzer, or something generic like the test coverage analyzer. To enable an analyzer on your repository, you must add it in your .deepsource.toml file.

Transformer

A transformer auto formats source code with popular code formatters like black, go fmt, etc. To enable a transformer on your repository, you must add it in your .deepsource.toml file.

Artifact

An artifact is a piece of external data used by an analyzer which is not available within a project's repository. Artifacts must be reported to DeepSource using the CLI. As an example, test coverage report files are artifacts used by DeepSource to report test coverage metrics.

DSN

A Data Source Name (or DSN) is a repository-specific endpoint identifier used to identify/authenticate the data source from where additional data (test coverage artifacts for example) is sent to DeepSource. DSNs are sensitive information and should never be exposed publicly.

Issue

An issue is a problem detected by an analyzer for a repository, which is recommended to be fixed. Issues can be of different types: bug risks, anti-patterns, security vulnerabilities, style violations, performance or documentation.

Metric

A metric is a measure of a key property of a repository, reported by an analyzer. Metrics can be reported by an analyzer internally, or using an external artifact.