ppicker 0.1.0__tar.gz → 0.2.0__tar.gz

ppicker-0.2.0/.github/workflows/crates.yml

@@ -0,0 +1,23 @@
+name: Publish to crates.io
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: Tag to publish
+        default: v0.1.0
+
+jobs:
+  crates:
+    runs-on: ubuntu-latest
+    # The CRATE_IO secret lives in the `pypi` environment.
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo publish --locked
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CRATE_IO }}

{ppicker-0.1.0 → ppicker-0.2.0}/Cargo.lock

@@ -1097,7 +1097,7 @@ checksum = "4a6394b9e965e73d0a289ee54f589087e2c676aedf60885baf52c76b771e4958"
 
 [[package]]
 name = "ppicker"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "clap",
@@ -1106,6 +1106,7 @@ dependencies = [
  "ratatui",
  "serde",
  "toml",
+ "which",
 ]
 
 [[package]]
@@ -1923,6 +1924,15 @@ dependencies = [
  "wezterm-dynamic",
 ]
 
+[[package]]
+name = "which"
+version = "8.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bae2f2b2b816647a1cab1acc91f5bd20812d53cb344382635ec2181940c8034f"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "winapi"
 version = "0.3.9"

{ppicker-0.1.0 → ppicker-0.2.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ppicker"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2024"
 description = "Fast project picker for tiling window managers: open a project in your editor"
 license = "MIT"
@@ -19,6 +19,7 @@ nucleo-matcher = "0.3.1"
 ratatui = "0.30.2"
 serde = { version = "1.0.229", features = ["derive"] }
 toml = "1.2.1"
+which = "8.0.6"
 
 [profile.release]
 opt-level = "z"

{ppicker-0.1.0 → ppicker-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppicker
-Version: 0.1.0
+Version: 0.2.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Programming Language :: Rust
@@ -102,6 +102,31 @@ default.
 
 ![Switching a project's editor with Ctrl-e](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/04-switch-editor.png)
 
+### Workspaces, not just folders
+
+A project does not have to be a folder. You can add a **workspace file** too, and ppicker opens it
+the way the editor expects:
+
+```shell
+pp add ~/work/shop.code-workspace     # a VS Code workspace
+pp add ~/work/site.sublime-project    # a Sublime Text project
+pp scan ~/work --workspaces           # also pick up workspace files while scanning
+```
+
+A workspace is named after its file (`Shop Front`) and marked with `◇` in the list; the details
+panel says what kind it is.
+
+![A VS Code workspace in the list](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/07-workspace.png)
+
+A `.code-workspace` file means something only to VS Code, so ppicker offers only editors that can
+open it. `Enter` uses the first VS Code editor in your `ides`, `→` lists just those (below, `code`
+only: vim and PyCharm are left out), and `Ctrl-e` cycles only through them.
+
+![Only editors that can open a workspace are offered](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/08-workspace-open-with.png)
+
+If none of your editors can open it, ppicker says which one to add instead of failing silently.
+A folder and a workspace file are separate entries, so one repository can appear as both.
+
 ### Use rofi, wofi or fuzzel instead
 
 If you already have a launcher you like, use it for the picking:
@@ -144,16 +169,55 @@ List the editors you use in the config file (run `pp paths` to see where it is).
 the default for projects you have not opened yet:
 
 ```toml
-ides = ["code", "pycharm", "vim"]
+ides = ["vscode", "pycharm", "zed"]
 scan_dirs = ["/home/me/code"]     # used by `pp scan` when you give no folder
 ```
 
-An editor is just a command. ppicker runs `<command> .` inside the project folder, for example
-`code .` or `pycharm .`. Anything that opens a folder works, including `idea`, `zed`, `subl`,
-`nvim` (see the note below for terminal editors) or `code -n`.
+Each entry is either a **name** ppicker knows, or a plain **command**.
+
+### Names: the same editor on every system
+
+Editor commands are called different things on different systems: `code` on Linux, `code.cmd` on
+Windows, `codium`, a flatpak... A name stands for a list of commands, and ppicker runs the first
+one it finds on your `PATH`. So the same config works everywhere:
+
+| Name | Tries, in order |
+|---|---|
+| `vscode` | `code`, `code-insiders`, `codium`, `vscodium`, the VS Code flatpak |
+| `pycharm` | `pycharm`, `pycharm-professional`, `pycharm-community`, `charm`, `pycharm64`, the PyCharm flatpaks |
+| `idea`, `webstorm`, `goland`, `rustrover`, `clion`, `phpstorm`, `rider`, `rubymine` | the usual launcher name of each (and its `64` variant) |
+| `sublime` | `subl`, `sublime_text`, `sublime-text` |
+| `zed` | `zed`, `zeditor` |
+| `cursor`, `windsurf` | the same name |
+
+If a name is not found you get an error that lists what was tried.
+
+### Plain commands
+
+Anything else is run as written, for example `code`, `idea`, `code -n` or `alacritty -e nvim`.
+Put a path with spaces in quotes: `"C:\Program Files\Some Editor\editor.exe"`. ppicker recognises
+the well-known commands (`code`, `codium`, `cursor`, `subl`, `pycharm`, ...) so it knows which
+projects they can open.
+
+### Your own command list
+
+If your install is somewhere unusual, or you want a different order, override a name (or define a
+new one) in `config.toml`. The first command that exists is used:
+
+```toml
+[commands]
+vscode = ['C:\Tools\VSCode\bin\code.cmd', "code"]   # my install first, then whatever is on PATH
+work = ["codium", "code"]                           # a new name, usable in `ides`
+```
+
+### How a project is opened
+
+A folder is opened as `<editor> .` from inside the folder. A workspace file is opened as
+`<editor> <file>` (see [Workspaces](https://github.com/roman-right/ppicker#workspaces-not-just-folders)). The editor is started detached,
+so it keeps running after ppicker exits.
 
 > **Terminal editors** such as vim or nvim need a terminal to run in. Use a command that starts
-> one, for example `ides = ["code", "alacritty -e nvim"]`.
+> one, for example `ides = ["vscode", "alacritty -e nvim"]`.
 
 ## Commands
 
@@ -168,8 +232,10 @@ pp editor myproj pycharm        # set it without opening
 pp editor myproj --reset        # forget it, back to the default editor
 pp add . --ide pycharm          # register the current folder and set its editor
 pp add . --name api -t work     # custom name, add a tag (repeat -t for more)
+pp add ~/w/shop.code-workspace  # add a workspace file instead of a folder
 pp scan ~/code -t work          # add every git repository in a folder
-pp list                         # show projects with their editors
+pp scan ~/code --workspaces     # ...and the workspace files in it (one level down)
+pp list                         # show projects with their editors (workspaces marked ◇)
 pp rm myproj                    # remove from the list (files are untouched)
 pp menu [--ask]                 # pick through rofi or another launcher
 pp paths                        # where the config and project list are stored
@@ -201,6 +267,9 @@ Two small text files you can read and edit; `pp paths` prints the exact location
 - `config.toml`: your settings (editors, scan folders).
 - `projects.toml`: your projects, their tags, last-opened time and remembered editor.
 
+To keep both somewhere else (a portable install, or to try things out without touching your
+real list), set `PPICKER_HOME` to a folder; ppicker then uses `config/` and `data/` inside it.
+
 ## Moving from `code-compass`
 
 ppicker replaces the old Qt-based `code-compass` package. See [docs/MIGRATION.md](https://github.com/roman-right/ppicker/blob/main/docs/MIGRATION.md)

{ppicker-0.1.0 → ppicker-0.2.0}/README.md

@@ -87,6 +87,31 @@ default.
 
 ![Switching a project's editor with Ctrl-e](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/04-switch-editor.png)
 
+### Workspaces, not just folders
+
+A project does not have to be a folder. You can add a **workspace file** too, and ppicker opens it
+the way the editor expects:
+
+```shell
+pp add ~/work/shop.code-workspace     # a VS Code workspace
+pp add ~/work/site.sublime-project    # a Sublime Text project
+pp scan ~/work --workspaces           # also pick up workspace files while scanning
+```
+
+A workspace is named after its file (`Shop Front`) and marked with `◇` in the list; the details
+panel says what kind it is.
+
+![A VS Code workspace in the list](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/07-workspace.png)
+
+A `.code-workspace` file means something only to VS Code, so ppicker offers only editors that can
+open it. `Enter` uses the first VS Code editor in your `ides`, `→` lists just those (below, `code`
+only: vim and PyCharm are left out), and `Ctrl-e` cycles only through them.
+
+![Only editors that can open a workspace are offered](https://raw.githubusercontent.com/roman-right/ppicker/main/assets/08-workspace-open-with.png)
+
+If none of your editors can open it, ppicker says which one to add instead of failing silently.
+A folder and a workspace file are separate entries, so one repository can appear as both.
+
 ### Use rofi, wofi or fuzzel instead
 
 If you already have a launcher you like, use it for the picking:
@@ -129,16 +154,55 @@ List the editors you use in the config file (run `pp paths` to see where it is).
 the default for projects you have not opened yet:
 
 ```toml
-ides = ["code", "pycharm", "vim"]
+ides = ["vscode", "pycharm", "zed"]
 scan_dirs = ["/home/me/code"]     # used by `pp scan` when you give no folder
 ```
 
-An editor is just a command. ppicker runs `<command> .` inside the project folder, for example
-`code .` or `pycharm .`. Anything that opens a folder works, including `idea`, `zed`, `subl`,
-`nvim` (see the note below for terminal editors) or `code -n`.
+Each entry is either a **name** ppicker knows, or a plain **command**.
+
+### Names: the same editor on every system
+
+Editor commands are called different things on different systems: `code` on Linux, `code.cmd` on
+Windows, `codium`, a flatpak... A name stands for a list of commands, and ppicker runs the first
+one it finds on your `PATH`. So the same config works everywhere:
+
+| Name | Tries, in order |
+|---|---|
+| `vscode` | `code`, `code-insiders`, `codium`, `vscodium`, the VS Code flatpak |
+| `pycharm` | `pycharm`, `pycharm-professional`, `pycharm-community`, `charm`, `pycharm64`, the PyCharm flatpaks |
+| `idea`, `webstorm`, `goland`, `rustrover`, `clion`, `phpstorm`, `rider`, `rubymine` | the usual launcher name of each (and its `64` variant) |
+| `sublime` | `subl`, `sublime_text`, `sublime-text` |
+| `zed` | `zed`, `zeditor` |
+| `cursor`, `windsurf` | the same name |
+
+If a name is not found you get an error that lists what was tried.
+
+### Plain commands
+
+Anything else is run as written, for example `code`, `idea`, `code -n` or `alacritty -e nvim`.
+Put a path with spaces in quotes: `"C:\Program Files\Some Editor\editor.exe"`. ppicker recognises
+the well-known commands (`code`, `codium`, `cursor`, `subl`, `pycharm`, ...) so it knows which
+projects they can open.
+
+### Your own command list
+
+If your install is somewhere unusual, or you want a different order, override a name (or define a
+new one) in `config.toml`. The first command that exists is used:
+
+```toml
+[commands]
+vscode = ['C:\Tools\VSCode\bin\code.cmd', "code"]   # my install first, then whatever is on PATH
+work = ["codium", "code"]                           # a new name, usable in `ides`
+```
+
+### How a project is opened
+
+A folder is opened as `<editor> .` from inside the folder. A workspace file is opened as
+`<editor> <file>` (see [Workspaces](https://github.com/roman-right/ppicker#workspaces-not-just-folders)). The editor is started detached,
+so it keeps running after ppicker exits.
 
 > **Terminal editors** such as vim or nvim need a terminal to run in. Use a command that starts
-> one, for example `ides = ["code", "alacritty -e nvim"]`.
+> one, for example `ides = ["vscode", "alacritty -e nvim"]`.
 
 ## Commands
 
@@ -153,8 +217,10 @@ pp editor myproj pycharm        # set it without opening
 pp editor myproj --reset        # forget it, back to the default editor
 pp add . --ide pycharm          # register the current folder and set its editor
 pp add . --name api -t work     # custom name, add a tag (repeat -t for more)
+pp add ~/w/shop.code-workspace  # add a workspace file instead of a folder
 pp scan ~/code -t work          # add every git repository in a folder
-pp list                         # show projects with their editors
+pp scan ~/code --workspaces     # ...and the workspace files in it (one level down)
+pp list                         # show projects with their editors (workspaces marked ◇)
 pp rm myproj                    # remove from the list (files are untouched)
 pp menu [--ask]                 # pick through rofi or another launcher
 pp paths                        # where the config and project list are stored
@@ -186,6 +252,9 @@ Two small text files you can read and edit; `pp paths` prints the exact location
 - `config.toml`: your settings (editors, scan folders).
 - `projects.toml`: your projects, their tags, last-opened time and remembered editor.
 
+To keep both somewhere else (a portable install, or to try things out without touching your
+real list), set `PPICKER_HOME` to a folder; ppicker then uses `config/` and `data/` inside it.
+
 ## Moving from `code-compass`
 
 ppicker replaces the old Qt-based `code-compass` package. See [docs/MIGRATION.md](https://github.com/roman-right/ppicker/blob/main/docs/MIGRATION.md)

{ppicker-0.1.0 → ppicker-0.2.0}/docs/MIGRATION.md

@@ -9,7 +9,8 @@ what you need to do, and how to bring your projects with you.
 1. **`ppicker` is released** on PyPI and crates.io. Its command is `pp`.
 2. **`code-compass` 0.2.0 is released** as a final version. It still works, but prints a notice
    when you start it and adds a `migrate` command that copies your projects to ppicker.
-3. **A migration period of at least 8 weeks** follows the 0.2.0 release.
+3. **A short migration period of about two weeks** follows the 0.2.0 release (until late
+   November 2026).
 4. **After that, the `code-compass` name on PyPI is handed over to a different, unrelated
    project.** Old `code-compass` releases may be removed from PyPI at that point.
 
@@ -34,6 +35,13 @@ pipx install ppicker          # or: uv tool install ppicker
 pipx run code-compass==0.2.0 migrate
 ```
 
+If the name on PyPI has already been handed over, install the final release straight from
+GitHub instead; it is the same code:
+
+```shell
+pipx run --spec git+https://github.com/roman-right/ppicker@code-compass-v0.2.0 code-compass migrate
+```
+
 This reads `~/.config/code_compass/data.db` and adds every project to ppicker. If `pp` is on your
 PATH it imports directly; otherwise it writes `ppicker-import.toml` and tells you to run
 `pp import ppicker-import.toml`. Running it twice is harmless: projects are matched by path, so

{ppicker-0.1.0 → ppicker-0.2.0}/e2e/scenario.sh

@@ -13,9 +13,9 @@ sleep 2
 
 # Fake editors that record where they were started, to prove the detached launch.
 for ed in code pycharm vim; do
-  printf '#!/bin/sh\npwd > /tmp/%s_called\n' "$ed" > /usr/local/bin/$ed && chmod +x /usr/local/bin/$ed
+  printf '#!/bin/sh\npwd > /tmp/%s_called\nprintf "%%s\\n" "$@" > /tmp/%s_args\n' "$ed" "$ed" > /usr/local/bin/$ed && chmod +x /usr/local/bin/$ed
 done
-reset_calls() { rm -f /tmp/code_called /tmp/pycharm_called /tmp/vim_called; }
+reset_calls() { rm -f /tmp/code_called /tmp/pycharm_called /tmp/vim_called /tmp/codium_called /tmp/*_args; }
 
 # Fake projects.
 mkdir -p ~/code && cd ~/code
@@ -88,6 +88,40 @@ sleep 1
 check "pp open uses the editor given at add time (vim)" "[ \"\$(called vim)\" = /root/code/dotfiles ]"
 $PP list
 
+echo "=== 7. workspaces: a .code-workspace file (with a space in its path) is a project too ==="
+mkdir -p "$HOME/code/my work"
+WS="$HOME/code/my work/Shop Front.code-workspace"
+printf '{"folders":[{"path":"."}]}' > "$WS"
+printf 'not a project' > "$HOME/code/plain.txt"
+$PP add "$WS" -t work
+check "workspace listed as a workspace, named after the file" "$PP list --plain | grep -q '^Shop Front.*workspace$'"
+check "a plain file is rejected" "! $PP add \$HOME/code/plain.txt >/dev/null 2>&1"
+check "pycharm is refused for a workspace" "! $PP open 'Shop Front' pycharm >/dev/null 2>&1"
+reset_calls
+popup
+xdotool type --delay 120 "shop"; sleep 1
+shot 7-workspace                      # marked with a diamond, "type VS Code workspace", editor = code
+xdotool key Right; sleep 1
+shot 8-workspace-open-with            # only editors that can open it
+xdotool key Return; sleep 2
+check "workspace opened by code from its own folder" "[ \"\$(called code)\" = '/root/code/my work' ]"
+check "workspace file passed whole, spaces intact" "[ \"\$(cat /tmp/code_args)\" = '$WS' ]"
+pkill alacritty 2>/dev/null; sleep 1
+
+echo "--- 'vscode' finds whichever VS Code command exists (here only codium)"
+reset_calls
+mv /usr/local/bin/code /tmp/code.real
+printf '#!/bin/sh\npwd > /tmp/codium_called\n' > /usr/local/bin/codium && chmod +x /usr/local/bin/codium
+printf 'ides = ["vscode"]\n' > ~/.config/ppicker/config.toml
+$PP editor "Shop Front" --reset >/dev/null   # it remembered the literal `code` from above
+$PP open "Shop Front"; sleep 1
+check "vscode resolved to codium" "[ \"\$(called codium)\" = '/root/code/my work' ]"
+mv /tmp/code.real /usr/local/bin/code; rm -f /usr/local/bin/codium
+printf 'ides = ["pycharm", "vim"]\n' > ~/.config/ppicker/config.toml
+$PP editor "Shop Front" --reset >/dev/null
+check "no editor can open it: error says what to add" "$PP open 'Shop Front' 2>&1 | grep -q 'VS Code.*vscode'"
+printf 'ides = ["code", "pycharm", "vim"]\n' > ~/.config/ppicker/config.toml
+
 echo "=== overview: every project, each with the editor it was last opened in ==="
 popup
 shot 0-overview