Closed MilesCranmer closed 6 months ago
MilesCranmer
commented
6 months ago Previous committers on this portion of the code include @cnpryer and @mitsuhiko. Do you think you could take a look?
(And I think @mitsuhiko is the only one with merge privileges?)
charliermarsh
commented
6 months ago I can review and merge.
UnderCooled
commented
5 months ago Error: nu::parser::multiple_rest_params
× Multiple rest params.
╭─[D:\dev_env\conf\nushell\scripts\rye.nu:85:28]
84 │ # Run the code formatter on the project
85 │ ╭─▶ export extern "rye fmt" [
86 │ │ ...paths: string # List of files or directories to limit the operation to
87 │ │ --all(-a) # Perform the operation on all packages
88 │ │ --package(-p): string # Perform the operation on a specific package
89 │ │ --pyproject: string # Use this pyproject.toml file
90 │ │ --verbose(-v) # Enables verbose diagnostics
91 │ │ --quiet(-q) # Turns off all output
92 │ │ ...extra_args: string # Extra arguments to ruff
93 │ │ --check # Run format in check mode
94 │ │ --help(-h) # Print help (see more with '--help')
95 │ ├─▶ ]
· ╰──── multiple rest params
96 │
╰────I think you should disable generating extra_args to export extern of "rye fmt" and "rye lint".
Nushell's export extern doesn't support -- as a valid flag currently anyway.
MilesCranmer
commented
5 months ago @UnderCooled I think this should be reported as an issue to https://github.com/clap-rs/clap instead so that it simply doesn't generate such completions in the first place
ndtoan96
commented
3 months ago I reported this issue to upstream: https://github.com/clap-rs/clap/issues/5592
This PR adds clap-based nushell completions.
Within the clap repository there is the
clap_complete_nushellcrate: https://github.com/clap-rs/clap/tree/master/clap_complete_nushell. I'm not sure why they have put it in a separate crate, and this means it requires some extra logic, but it's not too bad and as you can see I didn't need to change much.This should be backwards compatible.
I also update the docs and give an example.
Here what the output looks like (expand) ``` > rye self completion -s nushell ```
```nushell module completions { # An Experimental Package Management Solution for Python export extern rye [ --env-file: string # Load one or more .env files --version # Print the version --help(-h) # Print help ] def "nu-complete rye add pin" [] { [ "equal" "tilde-equal" "greater-than-equal" ] } # Adds a Python package to this project export extern "rye add" [ ...requirements: string # The package to add as PEP 508 requirement string. e.g. 'flask==2.2.3' --git: string # Install the given package from this git repository --url: string # Install the given package from this URL --path: string # Install the given package from this local path --absolute # Force non interpolated absolute paths --tag: string # Install a specific tag --rev: string # Update to a specific git rev --branch: string # Update to a specific git branch --features: string # Adds a dependency with a specific feature --dev # Add this as dev dependency --excluded # Add this as an excluded dependency that will not be installed even if it's a sub dependency --optional: string # Add this to an optional dependency group --pre # Include pre-releases when finding a package version --pin: string@"nu-complete rye add pin" # Overrides the pin operator --sync # Runs `sync` even if auto-sync is disabled --no-sync # Does not run `sync` even if auto-sync is enabled --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --help(-h) # Print help ] # Builds a package for distribution export extern "rye build" [ --sdist # Build a sdist --wheel # Build a wheel --all(-a) # Build all packages --package(-p): string # Build a specific package --out(-o): string # An output directory (defaults to `workspace/dist`) --pyproject: string # Use this pyproject.toml file --clean(-c) # Clean the output directory first --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --help(-h) # Print help ] def "nu-complete rye config format" [] { [ "json" ] } # Reads or modifies the global `config.toml` file export extern "rye config" [ --show-path # Print the path to the config --format: string@"nu-complete rye config format" # Request parseable output format rather than lines --get: string # Reads a config key --set: string # Sets a config key to a string --set-int: string # Sets a config key to an integer --set-bool: string # Sets a config key to a bool --unset: string # Remove a config key --help(-h) # Print help (see more with '--help') ] # Fetches a Python interpreter for the local machine. This is an alias of `rye toolchain fetch` export extern "rye fetch" [ version?: string # The version of Python to fetch --force(-f) # Fetch the Python toolchain even if it is already installed --target-path: string # Fetches the Python toolchain into an explicit location rather --build-info # Fetches with build info --no-build-info # Fetches without build info --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --help(-h) # Print help (see more with '--help') ] # Run the code formatter on the project export extern "rye fmt" [ ...paths: string # List of files or directories to limit the operation to --all(-a) # Perform the operation on all packages --package(-p): string # Perform the operation on a specific package --pyproject: string # Use this pyproject.toml file --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output ...extra_args: string # Extra arguments to ruff --check # Run format in check mode --help(-h) # Print help (see more with '--help') ] def "nu-complete rye init build_system" [] { [ "hatchling" "setuptools" "flit" "pdm" "maturin" ] } # Initialize a new or existing Python project with Rye export extern "rye init" [ path?: string # Where to place the project (defaults to current path) --lib # Generate a library project (default) --script # Generate an executable project --min-py: string # Minimal Python version supported by this project --py(-p): string # Python version to use for the virtualenv --no-readme # Do not create a readme --no-pin # Do not create .python-version file (requires-python will be used) --build-system: string@"nu-complete rye init build_system" # Which build system should be used (defaults to hatchling)? --license: string # Which license should be used (SPDX identifier)? --name: string # The name of the package --private # Set "Private :: Do Not Upload" classifier, used for private projects --no-import # Don't import from setup.cfg, setup.py, or requirements files --virtual # Initialize this as a virtual package --requirements(-r): string # Requirements files to initialize pyproject.toml with --dev-requirements: string # Development requirements files to initialize pyproject.toml with --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --help(-h) # Print help (see more with '--help') ] # Installs a package as global tool. This is an alias of `rye tools install` export extern "rye install" [ requirement: string # The name of the package to install --git: string # Install the given package from this git repository --url: string # Install the given package from this URL --path: string # Install the given package from this local path --absolute # Force non interpolated absolute paths --tag: string # Install a specific tag --rev: string # Update to a specific git rev --branch: string # Update to a specific git branch --features: string # Adds a dependency with a specific feature --include-dep: string # Include scripts from a given dependency --extra-requirement: string # Additional dependencies to install that are not declared by the main package --python(-p): string # Optionally the Python version to use --force(-f) # Force install the package even if it's already there --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --help(-h) # Print help ] # Updates the lockfiles without installing dependencies export extern "rye lock" [ --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output --update: string # Update a specific package --update-all # Update all packages to the latest --pre # Update to pre-release versions --features: string # Extras/features to enable when locking the workspace --all-features # Enables all features --with-sources # Set to true to lock with sources in the lockfile --reset # Reset prior lock options --pyproject: string # Use this pyproject.toml file --help(-h) # Print help ] # Run the linter on the project export extern "rye lint" [ ...paths: string # List of files or directories to limit the operation to --all(-a) # Perform the operation on all packages --package(-p): string # Perform the operation on a specific package --pyproject: string # Use this pyproject.toml file --verbose(-v) # Enables verbose diagnostics --quiet(-q) # Turns off all output ...extra_args: string # Extra arguments to ruff --fix # Apply fixes --help(-h) # Print help (see more with '--help') ] # Builds and prints a PEP 508 requirement string from parts export extern "rye make-req" [ ...requirements: string # The package to add as PEP 508 requirement string. e.g. 'flask==2.2.3' --git: string # Install the given package from this git repository --url: string # Install the given package from this URL --path: string # Install the given package from this local path --absolute # Force non interpolated absolute paths --tag: string # Install a specific tag --rev: string # Update to a specific git rev --branch: string # Update to a specific git branch --features: string # Adds a dependency with a specific feature --help(-h) # Print help ] # Pins a Python version to this project export extern "rye pin" [ version: string # The version of Python to pin --relaxed # Issue a relaxed pin --no-update-requires-python # Prevent updating requires-python in the pyproject.toml --pyproject: string # Use this pyproject.toml file --help(-h) # Print help (see more with '--help') ] # Publish packages to a package repository export extern "rye publish" [ ...dist: string # The distribution files to upload to the repository (defaults to