-
Notifications
You must be signed in to change notification settings - Fork 29
Adds VSCode migration page #93
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
a89a9bb
Adds VSCode migration page
samclark2015 b8401de
Adds migration page to the sidebar
samclark2015 3edd5bc
Updates to verbiage
samclark2015 fb4567f
Adds section about bundled IPykernel.
samclark2015 bd391f1
Adds capital-C Console to the accept list for Vale
samclark2015 4ada67b
Fixes linting error in unrelated file
samclark2015 fd987f0
Updates Python environment wording
samclark2015 3f34140
Updated verbiage based on latest recommendations
samclark2015 af839e7
Updates page title
samclark2015 3e5d2f3
Updates to change some verbiage; add Command Palette heading
samclark2015 d5fac70
Merge remote-tracking branch 'origin/main' into feature/vscode-migration
samclark2015 4b72f29
Update to move Python environment managers to included snippet
samclark2015 acabd8a
Removes "Positron's" contractions/possessives
samclark2015 cc27a2c
Merge branch 'main' into feature/vscode-migration
samclark2015 76d29a0
Updates to Language docs
samclark2015 7d33a0c
Merge remote-tracking branch 'origin/main' into feature/vscode-migration
samclark2015 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: Migrating from VS Code | ||
| title: Migrating to Positron from VS Code | ||
| --- | ||
| This document outlines how to migrate from VS Code to Positron, a data science-focused editor built on Code OSS. It covers importing VS Code settings and extensions, and explains Positron's enhanced data science features like the Console, Variables pane, Data Explorer, and Plots pane. The guide also details Positron's native support for Python and R workflows, including prerequisites and key differences from VS Code extensions. | ||
|
|
||
|
|
@@ -27,7 +27,7 @@ Positron supports importing settings from VS Code. It will prompt you to do so w | |
| If you skip this step, you can import settings at any time by opening the Command Palette (<kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and running the command _Preferences: Import Settings..._. | ||
|
|
||
| ### Installing extensions | ||
| Positron supports most extensions that you use in VS Code. These extensions can be installed using the Extensions pane, found in the Positron sidebar. | ||
| Positron supports many extensions that you use in VS Code. These extensions can be installed using the Extensions pane, found in the Positron sidebar. | ||
|
|
||
| If an extension does not appear in your search, it may be unavailable on the extension marketplace that Positron uses, [OpenVSX](https://open-vsx.org/). You can contact the developer of that extension to [request its publication to OpenVSX](extensions.qmd#open-vsx) for installation in Positron. | ||
|
|
||
|
|
@@ -65,17 +65,21 @@ VS Code users who rely on the `ms-python.python` extension will find that Positr | |
| - Formatting, using [Ruff](https://docs.astral.sh/ruff/) | ||
| - Debugging | ||
| - Jupyter notebook support | ||
| - Variables pane, for inspecting variables and data frames | ||
| - [Help pane](help-pane.qmd), for quick access to documentation | ||
|
|
||
| ### Python in the Console | ||
samclark2015 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Positron's Console pane provides an interactive IPython session. You can run type Python code directly into the Console or run files open in the editor. While you can launch IPython from the Terminal as you would in VS Code, the Console provides code completion, syntax highlighting, and integration with the Variables and Plots panes -- among other features that enhance the interactive experience. | ||
| Positron's Console pane provides an interactive IPython session. You can type Python code directly into the Console or run files open in the editor. You can also choose to run a portion of a file open in the editor, similar to a Jupyter Notebook but with any standard Python file. | ||
|
|
||
| While you can launch IPython from the Terminal as you would in VS Code, the Console provides code completion, syntax highlighting, and integration with the Variables and Plots panes -- among other features that enhance the interactive experience. | ||
samclark2015 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Positron bundles IPython, allowing you to use the console without installing it separately. If you wish to use an external version of IPython, you can toggle the use of the bundled one with the [`python.useBundledIpykernel` setting](positron://settings/python.useBundledIpykernel). | ||
|
|
||
| By default, the Console enables IPython's [`autoreload` extension](https://ipython.readthedocs.io/en/stable/config/extensions/autoreload.html) for imports. You can change this with the [`python.enableAutoReload` setting](positron://settings/python.enableAutoReload). | ||
samclark2015 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## R | ||
| Positron has a deeper and more cohesive integration for R workflows than VS Code. Its approach works seamlessly with R and does not require any extensions for this integration. You can use the Console for interactive R sessions, the Data Explorer for inspecting data frames, and the Plots pane for visualizing plots and other graphics. | ||
| Positron has a deeper and more cohesive integration for R workflows than VS Code. Its approach works seamlessly with R and does not require any extensions for this integration. You can use the Console for interactive R sessions, the Variables pane and [Data Explorer](data-explorer.qmd) for inspecting data frames, the Plots pane for visualizing plots and other graphics, and the [Help pane](help-pane.qmd) for quick access to documentation. | ||
|
|
||
| ### Prerequisites | ||
| To use R in Positron, you need to have R installed on your system. Positron automatically detects your R installation and provides full language support. | ||
|
|
@@ -85,6 +89,14 @@ To use R in Positron, you need to have R installed on your system. Positron auto | |
| If you have been accustomed to using the `vscode-r` extension in VS Code, be aware that [this extension is not compatible with Positron](extensions.qmd#non-compatible-extensions). Positron's native integration means you do not need the `vscode-r` extension; instead, Positron's built-in features allow you to work with your R code and data. | ||
| ::: | ||
| ::: | ||
| Positron's features are explored further in other Guides within this section. If you encounter any issues during migration or while using Positron, check out our [troubleshooting guide](troubleshooting.qmd) for common solutions. We also maintain a comprehensive [FAQ](faqs.qmd) that addresses frequent questions from users transitioning from other editors. | ||
|
|
||
| Your experience and feedback help us improve Positron. Share your thoughts, report bugs, or suggest features through our [feedback channels](feedback.qmd). We appreciate your input as we continue developing Positron to better serve the data science community. | ||
| ## Command palette | ||
|
|
||
| If you are familiar with the Command Palette in Visual Studio Code, you will find the experience in Positron very similar. All Positron-specific commands are included, alongside the familiar VS Code commands. | ||
|
|
||
| For a detailed overview of the Command Palette, see the [Visual Studio Code Command Palette documentation](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette). Most of the tips and workflows described there also apply to Positron. | ||
|
||
|
|
||
| ## Help & feedback | ||
| Positron's features are explored further in other Guides within this section. If you encounter any issues during migration or while using Positron, check out the [troubleshooting guide](troubleshooting.qmd) for common solutions. The [FAQ](faqs.qmd) addresses a comprehensive list of frequent questions from users transitioning from other editors. | ||
samclark2015 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Your experience and feedback help to improve Positron. Share your thoughts, report bugs, or suggest features through Positron's [feedback channels](feedback.qmd). Your input is valuable in making sure Positron development better serves the data science community. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.