Skip to content

A VSCode extension that allows you to hover over and click on file names within square brackets to instantly open them using your system's specific search engine.

License

Notifications You must be signed in to change notification settings

papple23g/file-linker

Repository files navigation

繁體中文說明

File Linker

A VSCode extension that allows you to hover over and click on file names within square brackets to instantly open them using your system's specific search engine.

Demo

Features

  • Instant File Opening: Hover over any file name enclosed in square brackets (e.g., [myfile.txt]) and click the link to open it instantly.
  • Cross-Platform Support: Works on both Windows and macOS.
  • Native Integration:
    • On Windows, it leverages the powerful Everything search engine.
    • On macOS, it uses the built-in Spotlight search (mdfind).
  • System-Wide Search: Finds files across your entire system, not just within the current workspace.
  • No Manual Pathing: Eliminates the need to manually browse or type file paths.

Requirements

  • Windows: The Everything application must be installed and running.
  • macOS: No additional software is needed. The extension uses the built-in Spotlight functionality.

Usage

  1. Mark Files: In any text file (code, notes, README, etc.), mark a file name using square brackets: [filename].
  2. Hover: Move your cursor over the file name within the brackets.
  3. Click: Click the "Open File" link that appears in the hover tooltip.

Extension Settings

This extension does not add any VS Code settings.

Known Issues

  • On Windows, the extension requires Everything to be running. If it's not, a helpful error message will guide you to install it.
  • On macOS, search results depend on your Spotlight index. If a file isn't found, ensure it's in a location indexed by Spotlight.

Release Notes

1.1.1

  • Added demo GIF to READMEs.
  • Added link to Chinese README in English README.

1.1.0

  • Added support for macOS using the native Spotlight search (mdfind).
  • The extension is now cross-platform.

1.0.0

  • Initial release of File Linker.
  • Hover and click functionality for opening files on Windows.
  • Bundled Everything CLI for seamless integration.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

A VSCode extension that allows you to hover over and click on file names within square brackets to instantly open them using your system's specific search engine.

Resources

License

Stars

Watchers

Forks