Create VSCode Extensions with python

Summary This PR reworks how Python is called in extension.js so that Python is called from the active Python environment in CS code.

Background In it's existing form, Python is directly immediately after imports based on architecture, and then in extensions code is generated based on architecture type in compiler.py. This means Python is called based on the system environment, rather than the active environment in VS Code.

What is Changed This PR grabs the path to the current Python environment from the official Python extension, ms-python. It then replaces the current way that Python is being called with the Python binary associated with the active environment.

Potential Pitfalls This may be a bad approach for situations where someone designs a fairly code agnostic extension, such as a color theme. For example, if someone installs a color theme designed in vscode-ext but they code in a language other than Python, it's unclear if the active Python environment exists or is even a good option. There may also be an issue if someone doesn't have the official Python extension installed. These should be fixable with a few lines of code, but I think feedback/discussion on this might be useful before additional work is performed.

Notes I only deleted 6 lines of code and added 3 lines of code at the top of data.py, but git decided to rewrite the whole file ¯_(ツ)_/¯

I was going to try and merge with your rewrite branch, but that looks like it's still pretty premature.

Related to #25

Hi, I just started with this and thanks for sharing.

I am trying to implement word completion in quick pick with items which files in working directory.

thus I tried as like this:

def search():
    cwd = os.getcwd()     # here, this line has the problem
    file_list = get_files_under(cwd)
    data = list(map(lambda path: vscode.ext.QuickPickItem(path), file_list))
    options = vscode.ext.QuickPickOptions(title='Select file to ...')
    selected = vscode.window.show_quick_pick(data, options)
    if not selected: return
    return selected

As I expected, cwd = '<project root directory as workspace>' like ~/vscode-ext-example/ but actually it is cwd = C:\Users\joonasyoon\AppData\Local\Programs\Microsoft VS Code

how can I get current directory for that?

I have multiple versions of VSCode installed locally and the script seems to pick the one in the PATH which is great but I'd like to configure it to provide my own path to VS code.exe of specific version.

Make it so display functions should take in args as lists and not strings, so we can pass in complete lists instead of passing the individually list values in the form of strings. Example: vscode.window.show_info_message("Options", ['opt-1', 'opt-2', 'opt-3'])

Just found this project, and thought it was pretty cool. I attempted to run the hello world example and I wasn't getting the info message. I have used the VS Code Yeoman template and have been able to get that running, so I suspect it's something to do with this package. I'm happy to provide any debug information needed.

I'm running VS Code 1.63 and using Python 3.9.

I could not find the file media/python.svg, so I created the file vscode-ext/examples/media/python.svg. Below you can see the python icon displaying in the activity bar.

s/media.

Another recommendation is to change the README.me, with easier directions instructions on how to run directly from the repository.

1. In VS Code:, open the folder .../vscode-ext/example
2. pip install virtualenv
3. python -m virtualenv .venv
4. .venv\Scripts\activate
5. pip install ..
6. python .py
7. depress F5

Please not every time you compile ,py, the files extension.p, extension.js,, extension.json and launch.json will change accordingly.

~~I'm back~~ The title says it all lmao (sorry for the almost-late-night pr)

Usage:

ext = vscode.Extension(
    some_stuff="here",
    categories=["testing"],  # default here is ["Other"]
    vscode_version="^1.56.0",  # default is "^1.58.0" (https://code.visualstudio.com/api/working-with-extensions/publishing-extension#visual-studio-code-compatibility)
    other_stuff=["h", "e", "r", "e"]
)

I guess this also fixes #26 since you can now customize the min-max vsc version for your extension (also, happy hacktoberfest! :D)

Currently, the new rewrite code that was recently merged into the repo does not support Linux pathing for the new virtual environment that is created. This PR fixes that.

resolves #31

~~pls ignore the first commit ty~~

Usage

res = vscode.window.show_workspace_folder_pick()

vscode.window.show_info_message(f"Nice you selected: {res['name']}")

Example

Code

import vscode
from vscode.config import Config, ConfigType

c = Config(name='Say', description='Say Something!', input_type=ConfigType.string, default="Hello World!")
ext = vscode.Extension('speaker','Speaker', '0.0.1', config=[c])

@ext.command()
def message_say_config():
    vscode.window.show_info_message(ext.get_config('Say') or c.default)

vscode.build(ext)

GIF Output

This PR converts most extension classes into pydantic classes.

The Extension class is not converted into a pydantic class because I am investigating a good approach to doing this. Effectively, Extension.py contains all information for package.json. The ideal approach is to get the json schema for package.json and autogenerate the pydantic classes, that way if the schema is updated then it is easy to update the class. However, there is no package.json schema that fits vscode extensions exactly. Rather, vscode uses NPMs package.json schema and then make modifications within the code rather than creating an actual schema.

What we can do is create an autogenerated package.json class, then make Extension a subclass and make the necessary changes to conform to vscode.

This PR also enforces some standards outlined in the vscode docs. For example, package versions should follow semantic versioning, so the pydantic classes validate the input version that is supplied to the class.

I submitted a PR recently and noticed that a bunch of rewrite code as implemented in the main repo. It breaks a lot of functionality, which is fine, but there is no replacement for much of the previous functionality. For example, it was possible for me to add in extensionDependencies when initializing the Extension object. Now you cannot do that, and you cannot set the version either. I understand breaking things when major versions change, but to have only a partial implementation of some of these things in the main repo is usually bad practice because this makes me resistant to work on any new contributions since I am losing functionality when trying to implement fixes or features.

Do you have a list of features/functionality you intend on implementing? I am happy to help implement some of this stuff, and if there are good reasons to not implement some of the features of the previous version, that's completely understandable. However, it's difficult to try and contribute if I don't know if features are intentionally left out or if they are incomplete.

Is there a way through the extension to get the filename and path to the currently open file or project in the editor? Something like pathlib.Path.cwd doesn't work if the user navigates to a different project within VSCode

vscode-ext: 1.5.4 vscode: 1.62.3 Windows: 21H1 (19043.1348)

I was getting Error: spawn python ENOENT when running the example https://github.com/CodeWithSwastik/vscode-ext/blob/main/examples/hello_world.py

[2021-11-21 20:59:10.224] [renderer16] [error] spawn python ENOENT: Error: spawn python ENOENT
	at Process.onexit (internal/child_process.js:269:19)
	at onErrorNT (internal/child_process.js:465:16)
	at processTicksAndRejections (internal/process/task_queues.js:80:21)

Following the suggestions in https://stackoverflow.com/a/54515183 I used the already present osvar to add spawnOptions to all the spawn calls in the generated extension.js

const osvar = process.platform;
spawnOptions = {shell: osvar == 'win32'}

I might be able to create a PR to solve this issue. Would the PR be reviewed? Is there any guidance on how to contribute?

I get an error when I run my function using Shift+Command+P. This is expected since my Python is not globally installed and comes from a virtualenv. How can I define path to Python?

An Error occurred in the python script: Python was not found c:\Program Files\Microsoft VS Code\1.58.2\resources\app\out\bootstrap-fork.js:5
An Error occurred in the python script:  but can be installed from the Microsoft Store: ms-windows-store://pdp/?productid=9NJ46SX7X90P