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

settings: Remove settings related to upstream python REPL #5931

Merged
merged 6 commits into from
Jan 15, 2025

Conversation

austin3dickey
Copy link
Contributor

This PR removes the python.REPL.* settings that come from the upstream, which aren't useful in Positron since we don't use the python REPL.

Release Notes

New Features

  • N/A

Bug Fixes

QA Notes

I validated that these settings don't appear in the settings menu anymore.

Copy link

github-actions bot commented Jan 9, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

Copy link

github-actions bot commented Jan 9, 2025

E2E Tests 🚀
This PR will run tests tagged with: @critical

readme  valid tags

@austin3dickey
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@austin3dickey
Copy link
Contributor Author

lint failure is due to #5930

@juliasilge
Copy link
Contributor

There is nothing for us to do to help manage the upstream merges for JSON files, is there? Should we add a note about this to https://connect.posit.it/positron-wiki/overlay-strategy.html?

@petetronic
Copy link
Collaborator

petetronic commented Jan 9, 2025

There is nothing for us to do to help manage the upstream merges for JSON files, is there? Should we add a note about this to https://connect.posit.it/positron-wiki/overlay-strategy.html?

In many other JSON files we've added // --- style comments, even if it is not official JSON syntax, the benefit has outweighed the strictness of syntax and those have been tolerated by scripts and applications. We could test it would be tolerated in these particular files to help future merging / code documentation first? If we run into issues, agree we could document it externally as a back up.

@austin3dickey
Copy link
Contributor Author

We could test it would be tolerated in these particular files to help future merging / code documentation first

Yeah, it turns out that they really don't like comments in package.json files.

npm ERR! code EJSONPARSE
npm ERR! path /home/runner/work/positron/positron/extensions/positron-python/package.json
npm ERR! JSON.parse Expected double-quoted property name in JSON at position 33261 while parsing near "... },\n                // --- Start Positro..."
npm ERR! JSON.parse Failed to parse JSON data.
npm ERR! JSON.parse Note: package.json must be actual JSON, not just JavaScript.

So I won't include the comments in the JSON files, and I'll add a little note in the wiki.

@austin3dickey
Copy link
Contributor Author

ah yeah, looks like some tests that change the settings to the non-default value are failing. I suppose I'll remove those tests.

@austin3dickey austin3dickey marked this pull request as ready for review January 14, 2025 18:48
@austin3dickey
Copy link
Contributor Author

Okay this should be ready for review!

@@ -151,7 +148,7 @@
"walkthrough.step.python.createEnvironment.title": "Select or create a Python environment",
"walkthrough.step.python.createEnvironment.description": {
"message": "Create an environment for your Python project or use [Select Python Interpreter](command:python.setInterpreter) to select an existing one.\n[Create Environment](command:python.createEnvironment)\n**Tip**: Run the ``Python: Create Environment`` command in the [Command Palette](command:workbench.action.showCommands).",
"comment": [
"comment": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some funky formatting inconsistencies between positron and the positron-python (that hopefully should be resolved soon with #5838) that can result in this weirdness via format-on-save 😩

Are you able to remove these unrelated whitespace changes? I believe the easiest way is to command palette Format Document from inside the extensions/positron-python workspace.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! I originally kept them because they seemed like improvements, but I can remove them from this PR since they're unrelated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, we inherited the weirdness from the upstream. :)

Copy link
Contributor

@isabelizimm isabelizimm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I also tried it out locally and could not sniff out any non-Positron REPL settings 🎉

Copy link
Contributor

@juliasilge juliasilge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much!

@austin3dickey austin3dickey merged commit 271dbb5 into main Jan 15, 2025
27 checks passed
@austin3dickey austin3dickey deleted the aus/old-settings branch January 15, 2025 16:42
@github-actions github-actions bot locked and limited conversation to collaborators Jan 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants