PDM

Work with PDM scripts as VS Code tasks, and run them directly from pyproject.toml files.

You need to have PDM Scripts defined in your pyporject.toml file for this extension to work:

[tool.pdm.scripts]
start = "flask run -p 54321"
lint = "flake8"
test.cmd = "pytest"
test.help = "Launch pytest"

Features

Task Running

This extension supports running pdm scripts defined in pyproject.toml files as tasks.

To run scripts as tasks, use the Tasks menu.

For more information about auto detection of Tasks, see the documentation.

Script Explorer

The PDM Script Explorer shows the pdm scripts found in your workspace. The explorer view is enabled by the setting pdm.enableScriptExplorer. A script can be opened or ran, from the explorer.

Run Scripts from the Editor

The extension supports to run the selected script as a task when editing the pyproject.toml file. You can either run a script from the hover shown on a script or using the command Run Selected PDM Script.

Run Scripts from a Folder in the Explorer

The extension supports running a script as a task from a folder in the Explorer. The command Run PDM Script in Folder... shown in the Explorer context menu finds all scripts in pyproject.toml files that are contained in this folder. You can then select the script to be executed as a task from the resulting list. You enable this support with the pdm.runScriptFromFolder which is false by default.

Workspace-aware

This extension should support multi-root workspaces, and will run scripts in the folder of the file that is currently active.

[!NOTE] This extension won't be active if your only open a file. You must always open a folder or workspace.

Settings

• pdm.autoDetect - Enable detecting scripts as tasks, the default is on.
• pdm.runQuiet - Run pdm script with the --quiet option, the default is false.
• pdm.packageManager - The package manager used to run the scripts: auto, pdm. The default is auto, which detects your package manager based on files in your workspace.
• pdm.exclude - Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the absolute path of the package.json. For example, to exclude all test folders use '**/test/**'.
• pdm.enableScriptExplorer - Enable the explorer view for PDM scripts.
• pdm.scriptExplorerAction - The default click action: open or run, the default is open.
• pdm.enableRunFromFolder - Enable running PDM scripts from the context menu of folders in Explorer, the default is false.
• pdm.scriptCodeLens.enable - Enable/disable the code lenses to run a script, the default is false.

TODO

• Clean REPO

Next steps / ideas

In no particular order. Feel free to contribute!

• [X] Setting for custom PDM interpreter path
• [X] Support for help arguments in pdm.scripts?
• Expose pdm commands as tasks (install, update, build, ...)
  • [ ] build: only if [build-system] is set
  • [ ] install plugins: only if [tool.pdm.plugins] is set
  • update/install/sync: only if [project.dependencies] is set or [tool.pdm.dev-dependencies] is set
• Expose project.scripts as tasks (or launch configurations?)
• [ ] CodeLens on plugins to install them automatically
• Support poethepoet with Poetry?
• Writing some tests?
• ~~Support for VS Code in browser?~~
• Cache tasks/pyproject.toml with workspaceState?
• Support *.pyproject.toml file pattern?
• Support internationalization (translations)
• Exclude some pyproject.toml files from auto detection (e.g. in venv, .pdm-build folders)
• CodeLens in lockfile (showing dependencies, dependents, ...)
• CodeLens on dependencies in pyproject.toml
• Run PDM scripts as tasks, or in the terminal

Required extensions

This extension requires a language extension for TOML files to be installed.

We recommend Even Better TOML, which will also validate pyproject.toml and pdm.toml files.

Credits

This project is based on the built-in VS Code NPM extension, published by Microsoft, released under MIT license.

Inspired by PDM Task Provider VS Code Extensions by KnowSuchAgency.

The PDM logo is released under MIT license by frostming.

This extension uses many dependencies, but special thanks to @ota-meshi for toml-eslint-parser.