https://github.com/discretetom/vscode-anchor

Quickly navigate to anchors in your code.
https://github.com/discretetom/vscode-anchor

code-anchor vscode vscode-extension

Last synced: 12 days ago
JSON representation

Quickly navigate to anchors in your code.

• Host: GitHub
• URL: https://github.com/discretetom/vscode-anchor
• Owner: DiscreteTom
• License: mit
• Created: 2023-11-12T02:44:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-19T02:46:17.000Z (over 1 year ago)
• Last Synced: 2023-11-19T05:23:43.766Z (over 1 year ago)
• Topics: code-anchor, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 319 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Code Anchor for VSCode

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/DiscreteTom.code-anchor?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=DiscreteTom.code-anchor)

![license](https://img.shields.io/github/license/DiscreteTom/vscode-anchor?style=flat-square)

Quickly navigate to anchors in your code.

![demo](./img/demo.png)

## Installation

Via VSCode Marketplace: [Code Anchor](https://marketplace.visualstudio.com/items?itemName=DiscreteTom.code-anchor).

## Features

- Syntax highlighting for anchors and references.

- Completion for references.

- Hover for details.

- Goto definition.

- Find all references.

- Rename definitions.

- Show all definitions in side bar.

- Diagnostics for unused, undefined and duplicated definitions.

- [Customizable](#customize).

- Fast. Powered by [`ripgrep`](https://github.com/BurntSushi/ripgrep).

## Usage

Create a definition/anchor in any file using the following syntax:

```

[[some words here]]

```

Then reference it in any file:

```

[[@some words here]]

```

> [!NOTE]

> Files in `.gitignore` are ignored.

## Customize

These options are customizable via VSCode's settings.

- Definition pattern.

- Reference pattern.

- Completion prefix pattern.

- Completion trigger characters.

- Diagnostic severity.

- Whether to allow unused definitions.

- Update file debounce latency.

## Credit

Inspired by [bimark](https://github.com/DiscreteTom/bimark).

## [CHANGELOG](./CHANGELOG.md)