Skip to content

Commit

Permalink
docs: Update README and metadata for VSCode Workspaces extension
Browse files Browse the repository at this point in the history
  • Loading branch information
ZanzyTHEbar committed Feb 11, 2025
1 parent 4301c7a commit 7e2efed
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 34 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,25 @@
# VSCode Nautilus Extension

![GitHub License](https://img.shields.io/github/license/ZanzyTHEbar/vscode-nautilus)
<!-- [![Lint](https://github.com/ZanzyTHEbar/vscode-nautilus/actions/workflows/eslint.yml/badge.svg)](https://github.com/ZanzyTHEbar/vscode-nautilus/actions/workflows/eslint.yml) -->
![GitHub License](https://img.shields.io/github/license/ZanzyTHEbar/vscode-workspaces)
<!-- [![Lint](https://github.com/ZanzyTHEbar/vscode-workspaces/actions/workflows/eslint.yml/badge.svg)](https://github.com/ZanzyTHEbar/vscode-workspaces/actions/workflows/eslint.yml) -->
![GNOME Extensions download](https://img.shields.io/badge/-vscode--workspaces--gnome-blue?logo=gnome&logoColor=white&colorA=252525&colorB=blue)

## Description

<!-- ![screenshot.png](screenshot.png) -->

VSCode Nautilus Extension is a project that provides a GNOME Shell extension for accessing visual studio code/codium recently opened workspaces/directories.
VSCode Workspaces is a project that provides a GNOME Shell extension for accessing visual studio code/codium recently opened workspaces/directories.

With workspace support, you can open a workspace in Visual Studio Code with a single click.

Provided are two other, optional, extensions for Nautilus.

The first, `vscode_nautilus_workspaces.py`, adds a right-click context menu to select from a list of recently accessed workspaces or directories and open in Visual Studio Code.

The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a folder or file in Visual Studio Code.

## Features

- Supports GNOME Shell 45 - 46
- Supports GNOME Shell 45+
- List all your local VSCode workspaces
- List all your remote VSCode projects
- Add a custom workspace by path
- Supports both Visual Studio Code and Codium
- Nautilus extensions for opening folders and files in Visual Studio Code
- Optional Nautilus extensions for opening folders and files in Visual Studio Code

## Install Extension

Expand All @@ -36,10 +30,20 @@ The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a
### Install from Source

```bash
bash <(wget -qO- https://raw.githubusercontent.com/ZanzyTHEbar/vscode-nautilus/main/install.sh)
bash <(wget -qO- https://raw.githubusercontent.com/ZanzyTHEbar/vscode-workspaces/main/install.sh)
```

## Uninstall GNOME Shell Extension
## Usage

### GNOME Shell Extension

To open a recent folder or workspace, click on the Visual Studio Code icon in the top bar and select a recent folder or workspace.

You also have various options to configure the extension in the GNOME Tweaks application.

Integrates well with the [VSCode Search Provider](https://extensions.gnome.org/extension/6976/vscode-search-provider/).

#### Uninstall GNOME Shell Extension

To uninstall a GNOME Shell extension, you can use the GNOME Tweaks application or the `gnome-extensions` command.

Expand All @@ -54,28 +58,24 @@ You can also remove the directory manually.
rm -rf ~/.local/share/gnome-shell/extensions/[email protected]
```

## Uninstall Nautilus Extensions
### Nautilus Extensions

```bash
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_workspaces.py
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_open.py
```
Provided are two other, optional, extensions for Nautilus.

## Usage
The first, `vscode_nautilus_workspaces.py`, adds a right-click context menu to select from a list of recently accessed workspaces or directories and open in Visual Studio Code.

### Nautilus Extensions
The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a folder or file in Visual Studio Code.

To open a folder or file in Visual Studio Code, right-click on an item in Nautilus and select the "Open in Code" option.

To open a recent folder or workspace, right-click on an empty space in Nautilus and select the "Open Recent Workspaces" option.

### GNOME Shell Extension

To open a recent folder or workspace, click on the Visual Studio Code icon in the top bar and select a recent folder or workspace.
#### Uninstall Nautilus Extensions

You also have various options to configure the extension in the GNOME Tweaks application.

Integrates well with the [VSCode Search Provider](https://extensions.gnome.org/extension/6976/vscode-search-provider/).
```bash
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_workspaces.py
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_open.py
```

## Development

Expand All @@ -88,8 +88,8 @@ Navigate to your desired directory and execute following commands in the termina
### GNOME 45+

```bash
git clone https://github.com/ZanzyTHEbar/vscode-nautilus.git
cd vscode-nautilus/gnome-extension
git clone https://github.com/ZanzyTHEbar/vscode-workspaces.git
cd vscode-workspaces/gnome-extension

make && make pack && make install
```
Expand Down
12 changes: 9 additions & 3 deletions gnome-extension/metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@
"name": "VSCode Workspaces",
"description": "A VSCode/Codium Workspace management tool-set for GNOME - This extension is not affiliated, funded, or in any way associated with Microsoft and vscode software.",
"uuid": "[email protected]",
"url": "https://github.com/ZanzyTHEbar/vscode-nautilus",
"url": "https://github.com/ZanzyTHEbar/vscode-workspaces",
"settings-schema": "org.gnome.shell.extensions.vscode-workspaces",
"shell-version": ["45", "46", "47"],
"shell-version": [
"45",
"46",
"47",
"48",
"49"
],
"donations": {
"github": "ZanzyTHEbar"
}
}
}
6 changes: 3 additions & 3 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ rm -f $NAUTILUS_EXTENSION_OPEN_PATH
# Function to download and install the Nautilus extension
install_nautilus_extensions() {
mkdir -p ~/.local/share/nautilus-python/extensions
wget --show-progress -q -O $NAUTILUS_EXTENSION_WORKSPACE_PATH https://raw.githubusercontent.com/ZanzyTHEbar/vscode-nautilus/main/vscode_nautilus_workspaces.py
wget --show-progress -q -O $NAUTILUS_EXTENSION_OPEN_PATH https://raw.githubusercontent.com/ZanzyTHEbar/vscode-nautilus/main/vscode-nautilus-open.py
wget --show-progress -q -O $NAUTILUS_EXTENSION_WORKSPACE_PATH https://raw.githubusercontent.com/ZanzyTHEbar/vscode-workspaces/main/vscode_nautilus_workspaces.py
wget --show-progress -q -O $NAUTILUS_EXTENSION_OPEN_PATH https://raw.githubusercontent.com/ZanzyTHEbar/vscode-workspaces/main/vscode-nautilus-open.py

# Ensure the Python scripts are executable
if [ -f $NAUTILUS_EXTENSION_WORKSPACE_PATH ] && [ -f $NAUTILUS_EXTENSION_OPEN_PATH ]; then
Expand All @@ -70,7 +70,7 @@ install_nautilus_extensions() {
# URL to check
URL_TO_CHECK=""
# GitHub repository and file to download
GITHUB_REPO="ZanzyTHEbar/vscode-nautilus"
GITHUB_REPO="ZanzyTHEbar/vscode-workspaces"
RELEASE_FILE="vscode-workspaces.zip"

# Function to check if URL exists
Expand Down

0 comments on commit 7e2efed

Please sign in to comment.