Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid quotes in suggested .env file for IDEs (Cherry-pick of #20144) #20145

Merged
merged 1 commit into from
Nov 3, 2023

Commits on Nov 3, 2023

  1. Avoid quotes in suggested .env file for IDEs (#20144)

    This fixes #20127 by avoiding double quotes in the `.env` file generated
    by the code snippet in the IDE set-up docs.
    
    Double quotes aren't supported by the `scie-pants` `.env` loader, and a
    line containing them was previously silently ignored (plus all lines
    after), but with scie-pants 0.11.0, will be an error. See
    pantsbuild/scie-pants#307 and
    pantsbuild/scie-pants#319.
    
    The new suggestion has _no_ quotes at all, because there's no other way
    to have a line that includes a substitution. To handle source roots with
    spaces in their paths, this has to also manually escape them. Supporting
    double quotes is effectively a new feature of `scie-pants` launcher (via
    scie jump a-scie/jump#166 via `dotenvy`
    allan2/dotenvy#11), but for now we can at
    least stop suggesting incorrect things.
    
    For instance, with source roots `a b/c` and `def`, this generates:
    
    ```
    PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
    ```
    huonw authored and WorkerPants committed Nov 3, 2023
    Configuration menu
    Copy the full SHA
    8a2279b View commit details
    Browse the repository at this point in the history