https://github.com/kitschpatrol/vscode-aphex-preview
Thumbnail preview images on hover for @kitschpatrol/unplugin-aphex URLs.
https://github.com/kitschpatrol/vscode-aphex-preview
aphex apple apple-photos extension hover image-preview photokit photos thumbnail vsc vscode
Last synced: 7 days ago
JSON representation
Thumbnail preview images on hover for @kitschpatrol/unplugin-aphex URLs.
- Host: GitHub
- URL: https://github.com/kitschpatrol/vscode-aphex-preview
- Owner: kitschpatrol
- License: mit
- Created: 2025-12-28T05:18:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-04-27T17:06:55.000Z (about 1 month ago)
- Last Synced: 2026-04-27T18:34:51.735Z (about 1 month ago)
- Topics: aphex, apple, apple-photos, extension, hover, image-preview, photokit, photos, thumbnail, vsc, vscode
- Language: TypeScript
- Size: 11.9 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# VS Code Aphex Preview Extension
[](https://opensource.org/license/mit/)
[](https://github.com/kitschpatrol/vscode-aphex-preview/actions/workflows/ci.yml)
[](https://marketplace.visualstudio.com/items?itemName=kitschpatrol.aphex-preview)
**Thumbnail preview images on hover for @kitschpatrol/unplugin-aphex URLs.**
## Getting started
_Let's assume you have [VS Code](https://code.visualstudio.com) installed and are working in a project using the [unplugin-aphex](https://github.com/kitschpatrol/unplugin-aphex) build tool plugin to integrate photos from your local Apple Photos.app library into your build pipeline via the [Aphex](https://github.com/kitschpatrol/aphex) project._
Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=kitschpatrol.aphex-preview), or run the following in VS Code's command palette:
```sh
ext install kitschpatrol.aphex-preview
```
Now, when you hover over an Aphex-style link in your code, you should see a live preview thumbnail of the referenced photo.
For now, this extension does not itself resolve or fetch images; it only provides thumbnail previews for cached Aphex URLs that have already been resolved by [unplugin-aphex](https://github.com/kitschpatrol/unplugin-aphex) via [Aphex](https://github.com/kitschpatrol/aphex).
This plugin will _technically_ function and resolve from an existing image cache on Linux and Windows versions of VS Code, but the underlying Aphex pipeline (and the entire premise of resolving assets from a local Apple Photos.app library) will only work on the macOS platform.
## Configuration
The extension provides the following settings:
| Setting | Default | Description |
| ---------------------------- | ---------------------------------------------------- | ----------------------------------------- |
| `aphex-preview.manifestPath` | `node_modules/.cache/aphex/.aphex-plugin-cache.json` | Path to the Aphex cache manifest file |
| `aphex-preview.maxWidth` | `300` | Maximum width for image previews (points) |
## Supported file types
Hover previews work in the following file types: JavaScript, TypeScript, JSX, TSX, Markdown, MDX, HTML, Astro, and Svelte.
## Maintainers
[kitschpatrol](https://github.com/kitschpatrol)
## Contributing
[Issues](https://github.com/kitschpatrol/vscode-aphex-preview/issues) are welcome and appreciated.
Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.
This repository uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) (via its `ksc` CLI) for linting and formatting, plus [MDAT](https://github.com/kitschpatrol/mdat) for readme placeholder expansion.
## License
[MIT](LICENSE.txt) © [Eric Mika](https://ericmika.com)