https://github.com/ntnyq/vscode-magic-comment

:apple: Add annotations to magic comments
https://github.com/ntnyq/vscode-magic-comment

Last synced: 6 days ago
JSON representation

:apple: Add annotations to magic comments

• Host: GitHub
• URL: https://github.com/ntnyq/vscode-magic-comment
• Owner: ntnyq
• License: mit
• Created: 2024-10-23T22:44:19.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-03-10T02:32:45.000Z (7 months ago)
• Last Synced: 2025-04-04T18:53:49.333Z (7 months ago)
• Language: TypeScript
• Size: 849 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-magic-comment

[![CI](https://github.com/ntnyq/vscode-magic-comment/workflows/CI/badge.svg)](https://github.com/ntnyq/vscode-magic-comment/actions)

[![MARKETPLACE](https://img.shields.io/github/v/release/ntnyq/vscode-magic-comment?include_prereleases&label=Visual%20Studio%20Marketplace)](https://marketplace.visualstudio.com/items?itemName=ntnyq.vscode-magic-comment)

[![LANGUAGE](https://img.shields.io/github/languages/top/ntnyq/vscode-magic-comment)](https://github.com/ntnyq/vscode-magic-comment)

[![LICENSE](https://img.shields.io/github/license/ntnyq/vscode-magic-comment)](https://github.com/ntnyq/vscode-magic-comment/blob/main/LICENSE)

> Highlight and add annotations to magic comments.

> [!CAUTION]

> Work in progress. May not stable yet.

## Features

- Highlight magic comments

- Add annotations to magic comments

## Providers

> Sorted alphabetically

- autoprefixer ✅

- biome ✅

- c8

- case-police ✅

- compiler-hint ✅

- cspell ✅

- dprint ✅

- eslint

- istanbul

- jshint

- markdownlint

- prettier ✅

- remark

- stylelint ✅

- typescript ✅

- unocss ✅

- v8 ✅

- vite ✅

- vue ✅

- webpack ✅

More comming soon.

## Commands

| Command                           | Title                            |

| --------------------------------- | -------------------------------- |

| `magic-comment.getLanguageConfig` | Magic Comment: getLanguageConfig |

## Configs

| Key                                 | Description                   | Type      | Default                                                                                       |

| ----------------------------------- | ----------------------------- | --------- | --------------------------------------------------------------------------------------------- |

| `magic-comment.annotation`          | Magic comment annotation      | `object`  | `{ "after": { "contentText": "🚀", "margin": "0 0 0 0.5em" }, "color": "rgb(255, 189, 42)" }` |

| `magic-comment.customMagicComments` | User defined magic comments   | `array`   | `[]`                                                                                          |

| `magic-comment.disabledCategories`  | Disabled by comments category | `array`   | `[]`                                                                                          |

| `magic-comment.disabledNames`       | Disabled by comments name     | `array`   | `[]`                                                                                          |

| `magic-comment.enable`              | Enable extension              | `boolean` | `true`                                                                                        |

| `magic-comment.ignorePaths`         | Ignored paths pattern         | `array`   | `[]`                                                                                          |

| `magic-comment.languages`           | Enabled by language ids       | `array`   | `["javascript","javascriptreact","markdown","typescript","typescriptreact"]`                  |

## License

[MIT](./LICENSE) License © 2024-PRESENT [ntnyq](https://github.com/ntnyq)