Skip to content

Latest commit

 

History

History
118 lines (70 loc) · 5.89 KB

README.md

File metadata and controls

118 lines (70 loc) · 5.89 KB

Ulauncher VSCode Projects Extension

Ulauncher extension that allows you to quickly open your VSCode projects, either managed by [VSCode Project Manager] (https://github.com/alefragnani/vscode-project-manager) extension or from VSCode Recent workspaces.

Ulauncher Extension CI Status License

Demo

demo

Requirements

  • Ulauncher 5
  • Python 3
  • Visual Studio Code
  • Project Manager extension, if you want to use it. otherwise you can configure the extension to look only to the VSCode workspaces.

Install

You must install the following Python packages required by this extension. You can run the following command in the terminal:

pip install --user memoization==0.4.0

In some Operating systems, you might have to run pip3 instead of pip

Open ulauncher preferences window -> extensions -> add extension and paste the following url:

https://github.com/brpaz/ulauncher-vscode-projects

Usage

Type vsp into ulauncher input, to trigger this extension. You can optionally keep typing to filter the projects list.

Project Manager managed projects will appear with the "briefcase" icon, while "Recent workspaces" will have a dark VSCode icon.

If you want to only see projects from one of these sources, you can configure it in the extension settings.

Extension Settings

Name Description Default value
Config path The path to VSCode's config folder. You can change this value if to point to your Codium install for example. ~/.config/Code/
Projects File path The location of of projects file cache created by Project Manager VSCode Extension "~/.config/Code/User/globalStorage/alefragnani.project-manager/
VS Code executable path The path to the VSCode executable. You might want to change is if using Codium or VSCode from Flatpa code
Include recent workspaces "When to include recent workspaces true
Include project manager projects Include projects from the Project Manager extension true

Development

git clone https://github.com/brpaz/vscode-projects
make link

The make link command will symlink the cloned repo into the appropriate location on the ulauncher extensions folder.

The make link command will symlink the cloned repo into the appropriate location on the ulauncher extensions folder.

To see your changes, stop ulauncher and run it from the command line with: make dev.

The output will display something like this:

2020-11-15 10:24:16,869 | WARNING | ulauncher.api.server.ExtensionRunner: _run_process() | VERBOSE=1 ULAUNCHER_WS_API=ws://127.0.0.1:5054/ulauncher-vscode-projects PYTHONPATH=/usr/lib/python3.8/site-packages /usr/bin/python3 /home/bruno/.local/share/ulauncher/extensions/ulauncher-vscode-projects/main.py

Open another terminal window and execute the command displayed, "starting at VERBOSE=1". This will activate the extension.

To see your changes, CTRL+C the previous command and run it again to refresh.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

💛 Support the project

If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.

The sinplest form of support is to give a ⭐️ to this repo.

You can also contribute with GitHub Sponsors.

GitHub Sponsors

Or if you prefer a one time donation to the project, you can simple:

Buy Me A Coffee

Author

👤 Bruno Paz

License

Copywright @ 2019 Bruno Paz

This project is MIT Licensed.