How do you install leointeg into VS Code?

[Edward K. Ream]

The leointeg page doesn't seem to have any installation instructions.

I would love to try this out.

Edward

[Robert Cholette]

1 - have vscode installed on your computer, obviously

2 - git clone the project into a folder 

3 - right-click that folder -> open with vscode, OR from inside a vscode window, File-> Open Folder... 

4 - this will open a vscode window for working on leoInteg, it will recognize that this is an expansion development project and will allow you to just hit F5 to run it.

( upon hitting F5 another vscode window will appear with the expansion installed and running, messages and errors are logged at the bottom of the one you pressed F5 )

So basically, just opening the leoInteg project in vscode allows you to try it out by pressing F5 (run / start a debug session) 

P.S. Please do not hesitate to try and crash my expansion to find bugs! (such as try to open multiple views of the same body pane, or open multiple different body panes simultaneously and see the outline focus on the right node as you click inside different body panes, try to modify a body and rapidly close the tab before the 500 milliseconds has passed to write it in leo, and reopen it to see that the change was made, etc..)

P.P.S Indeed, this is not a proper 'permanent installation' of the plugin into your vscode installation, rather just the proper way to run and try out an expansion. (Since this is a beta version that offers only browsing and body/headline edition without proper saving, I'm sure no one wants to do anything serious with it - thats why I didnt bother to package it into a proper expansion yet.)

[Edward K. Ream]

On Thu, Oct 10, 2019 at 2:48 PM Robert Cholette wrote:

So basically, just opening the leoInteg project in vscode allows you to try it out by pressing F5 (run / start a debug session) 

Thanks.  I'll get to this very soon.

It would be good to put the full instructions in the readme file.

Edward

[Edward K. Ream]

On Thu, Oct 10, 2019 at 2:51 PM Robert Cholette <felix...@gmail.com> wrote:

P.S. Please do not hesitate to try and crash my expansion to find bugs!

Hehe.  What else did you expect?

Edward

[Edward K. Ream]

On Thursday, October 10, 2019 at 2:48:21 PM UTC-5, Robert Cholette wrote:

1 - have vscode installed on your computer, obviously

2 - git clone the project into a folder 

3 - right-click that folder -> open with vscode, OR from inside a vscode window, File-> Open Folder... 

Well, that was easy :-)

4 - this will open a vscode window for working on leoInteg, it will recognize that this is an expansion development project and will allow you to just hit F5 to run it.

I get the following after F5:

Cannot find module 'vscode'.

Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.

Failed to load the TSLint library for 'c:/leo.repo/leointeg/src/leoBody.ts'
To use TSLint, please install tslint using 'npm install tslint' or globally using 'npm install -g tslint'.
Be sure to restart your editor after installing tslint.

What should I do now?

Edward

[Robert Cholette]

By the spirit of Shannon! I forgot the most important step: Installing dependencies! 

Assumings you have node.js installed on your computer, install all dependencies by running 'npm install' from inside the expansion directory. (this will install all dependencies listed at the end of package.json)

Thanks for making the observation that those instructions are lacking in the README.md, I'll add instructions before going to bed this evening

--

Félix

On Thursday, October 10, 2019 at 2:09:47 PM UTC-4, Edward K. Ream wrote:

[Robert Cholette]

thought i might add this in here... 

Here's a nice feature of  vscode: 

There's a terminal at the bottom of vscode (pull/drag from the bottom if already closed) so you can use it after opening the expansion folder to run 'npm install' without even opening a terminal prompt.

wait for those dependencies to install and hit F5 :) 

Cheers to all you Leo users out there!

On Thursday, October 10, 2019 at 2:09:47 PM UTC-4, Edward K. Ream wrote:

[Edward K. Ream]

On Thu, Oct 10, 2019 at 7:50 PM Robert Cholette <felix...@gmail.com> wrote:

wait for those dependencies to install and hit F5 :) 

Seems to have gone well:

(base) c:\leo.repo\leointeg>npm install
added 142 packages in 4.958s

I hit F5, and there was a messages about building, iirc. I see Leointeg and outline in the explorer.

Remaining problems:

- The outline area is empty and apparently non-functional.

- When I search for leointeg in extensions, I see nothing.

- I see 27 problems in leoBody.ts.

What do I do now?

Edward

[Robert Cholette]

 I should have given some more details about the expansion startup : 

 

 It will 'activate' if the current working folder contails a leo file, or if the user manually switches to the 'Leo' view panel (Bottom left)

 Once 'activated', an 'Open Leo File' folder icon will be available on the 'LEO: OUTLINE' bar upon hovering. 

 

- The outline area is empty and apparently non-functional.

Yes its normal, you should now hover the leo:outline bar to see the 'Open Leo File' folder icon to open a leo file. either on the 'explorer View' (available if the current workspace has a leo file) or on the 'Leo View' 

- When I search for leointeg in extensions, I see nothing.

Normal, its not a finished / published expansion yet :) You will see leoInteg stuff in the 'settings' [Ctrl+,] though (switch to visual mode if you see ust json text - togle in upper right)

- I see 27 problems in leoBody.ts.

About that 27 problems in the log pane, that's because that new window that opened when you hit F5 was opened with a 'Workspace' consisting of the leoInteg project itself. You might not have the proper tools/expansion in vscode to have it show that kind of project folder without 'problems'. 

You can ignore them - but I would recomment that when the new vscode instance popsup after hitting F5, that you try the 'File->Open Folder' command to open a personal project folder (that contains a Leo file) . If you close it and later retry leointeg, it will reopen with that folder as workspace. (the leo file in leoInteg is empty so its pretty boring anyways) :)

Thank you and Sorry for this lack of proper detailing for starting people to try/use the expansion, This is making me realise what kind of 'help' paragraph I should put in the README.md. file

EDIT : I will also try the process of installing vscode and leoInteg on a brand new computer at work so that I see what I might have overlooked as dependencies/procedures from the point of view of someone that has nothing but a virgin OS/computer... :)

--

Félix

[Arjan]

I'm not yet able to get a Leo outline working with these instructions. I do get the new window with a Leo icon in the sidebar, but opening a folder with .leo files doesn't provide an outline view, and I don't see an "Open Leo File" on the Leo view.

Is there a way to check if the Python/Leo setup itself is configured correctly? I'm normally using Anaconda with Python3, with a Leo git repo located in C:\Programs\Leo, on Windows 10. And I normally start Leo by running a .bat file I've placed on my PATH:

@ECHO OFF
START "" C:\Programs\Anaconda3\pythonw.exe C:\Programs\Leo\launchLeo.py --no-dock

I've added `C:\Programs\Leo` to a newly created env var "PYTHONPATH" (it didn't exist yet). Seems like picking up the Python install could be my problem?

[Robert Cholette]

but opening a folder with .leo files doesn't provide an outline view, 

Opening a workspace folder that contains a leo file will not open a leo outline, indeed, it will just activate the expansion so that the 'Open Leo File Button' can now appear (When hovering the leo:Outline bar)  Either on the explorer view or on the 'Leo' view.

See this gif in the first few frames... (I'll get a 'virgin' windows machine tonight to try out the full install of everything from scratch & see where I need to supply more help/dependencies/whatever)

[Arjan]

Yeah, problem is I don't have the Open Leo File button: 

[Robert Cholette]

I see now... And is there anything in the debug console terminal of the window underneath? (the window of the leoInteg project where you pressed F5 to run)

Problems logged are not printed in the window where the extension can be used, but instead they appear in the Debug Console of the instance of vscode where leoInteg project is opened.

thanks again, I'll try a full install of everything from scratch on windows later this evening. 

Your error reporting is greatly appreciated you guys. 

[Arjan]

Just one warning:

(node:6096) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
warning.js:18

It looks like an awesome way of using Leo, so thank you for making it and for looking into our issues!

Cheers

[Robert Cholette]

Thanks Arjan, that's a normal warning to get on the first run. 

I'm really eager to try all of this under windows. (I know I should have tought of that before!! I mainly work in ubuntu but I can dual boot on windows 10 on my machine so I'll try it out after work to see what's the problem in windows) 

I have a long weekend of 3 days coming up so i'll try to fix all of that and get you guys up and running. (and also implement the rest of the functionality for basic leo commands)

Edward are you on windows too? 

[Chris George]

I run on Ubuntu and can do pretty much everything you detailed in your earlier postings.

I look forward to your progress.

Chris

--
You received this message because you are subscribed to the Google Groups "leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/0d891059-bc21-4060-8c03-43c3fefdef18%40googlegroups.com.

[Félix]

Thank you Chris, your report is much appreciated.

It seems to be on windows that a mysterious dependency is lacking (or something other than Leo's path in $PYTHONPATH environment variable, or other generic $PATH entry missing...)

In the near future, as soon as I figure out the 'windows' missing dependencies, I'll make tests at startup of the extension to detect missing environment path entries, or other missing dependencies, and then popup error messages to alert and inform the user about it.

Note to other people reading this thread: Please indicate what OS you're using, Thanks! :)

--

Félix 

On Friday, October 11, 2019 at 4:17:05 PM UTC-4, Chris George wrote:

I run on Ubuntu and can do pretty much everything you detailed in your earlier postings.

I look forward to your progress.

Chris

On Fri, Oct 11, 2019 at 1:05 PM Robert Cholette <felix...@gmail.com> wrote:

Thanks Arjan, that's a normal warning to get on the first run. 

I'm really eager to try all of this under windows. (I know I should have tought of that before!! I mainly work in ubuntu but I can dual boot on windows 10 on my machine so I'll try it out after work to see what's the problem in windows) 

I have a long weekend of 3 days coming up so i'll try to fix all of that and get you guys up and running. (and also implement the rest of the functionality for basic leo commands)

Edward are you on windows too? 

On Friday, October 11, 2019 at 3:37:05 PM UTC-4, Arjan wrote:

Just one warning:

(node:6096) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
warning.js:18

It looks like an awesome way of using Leo, so thank you for making it and for looking into our issues!

Cheers

--
You received this message because you are subscribed to the Google Groups "leo-editor" group.

To unsubscribe from this group and stop receiving emails from it, send an email to leo-e...@googlegroups.com.

[Edward K. Ream]

On Fri, Oct 11, 2019 at 3:43 PM Félix <felix...@gmail.com> wrote:

> Note to other people reading this thread: Please indicate what OS you're using, Thanks! :)

I have been trying this on Windows.  I'll try on Ubuntu soon.

Edward

[Félix]

Support for Windows is now fixed! I've now tested it sucessfully on a new 'blank' windows 10 machine. Sorry about that, I thought there was nothing OS dependant in this. Turns out there was 2 minuscule details I overlooked.

After pulling this last update make sure to re-run 'npm install' as I have added a small dependency to help check that python is in the OS's path. 

Silly overlooks from my part : I had taken for granted that 'python3' was the universal way to invoke python 3. I now try 'python3', 'py' (for windows) and lastly 'python'. I also provide an option to override this string in the settings for 'Leo Integration'. 

I also was crashing my 'open leo file' JSON with the backslashes that windows gave back to vscode's file browsing / choosing dialog. For now as a temporary fix I just replace backslashes with slashes and it seems to work fine. 

I suspect it might not work for paths with spaces and am thinking about implementing a more stable and elegant solution. 

Many thanks to Edward for reporting this! 

tldr; Pull, run 'npm install' and you're good to go!

[Edward K. Ream]

On Fri, Oct 11, 2019 at 5:28 PM Félix <felix...@gmail.com> wrote:

haha we're both stuck trying to install and run each other's product!

I installed python 3 (latest from python.org) and leo from sources on windows, cd into leo's dir and this is what I get :

D:\prog\leo-editor>py launchLeo.py

Traceback (most recent call last):

  File "launchLeo.py", line 7, in <module>

    import leo.core.runLeo

  File "D:\prog\leo-editor\leo\core\runLeo.py", line 25, in <module>

    import leo.core.leoGlobals as leoGlobals

  File "D:\prog\leo-editor\leo\core\leoGlobals.py", line 68, in <module>

    import urllib.parse as urlparse

ImportError: No module named parse

Hmm.  urllib.parse is part of Python's standard library.  This would be a major bug in the Python 3.7 distro.

This looks like an installation problem on your end.  In a console, type `where python`.  It should point at python.exe in the 3.7 distro, but I'm guessing it doesn't.

Edward

[Edward K. Ream]

On Fri, Oct 11, 2019 at 11:32 PM Félix <felix...@gmail.com> wrote:

Support for Windows is now fixed!

Thanks.

tldr; Pull, run 'npm install' and you're good to go!

Did that, with no errors.

git status shows:

     modified:   package-lock.json
     modified:   package.json

When I open VS code, the Source Code pane shows that the above two files have changed, with a message "Ctrl+Enter to commit on master".  Should I do that?

I see all the sources for leointeg itself, but no files. I'm sure this would be confusing to new users of leointeg. Earlier you said,

   Once 'activated', an 'Open Leo File' folder icon will be available

   on the 'LEO: OUTLINE' bar upon hovering.

I see the OUTLINE bar, but I don't see any way to load a Leo file.

Edward

[Edward K. Ream]

On Saturday, October 12, 2019 at 6:23:55 AM UTC-5, Edward K. Ream wrote:

tldr; Pull, run 'npm install' and you're good to go!

I did that on Ubuntu.  Within VS code I selected the leointeg folder and did F5.

I see the LEOINTEG and OUTLINE panes, but I see no folder in the OUTLINE pane.

Edward

[Arjan]

Here's what I got. I did:

1. `cd leointeg`; `git checkout .`; `git pull`

2. npm install

added 2 packages from 4 contributors and audited 313 packages in 1.678s

Then F5 gives me the extension, but still without a Load File option in the Leo tab. I get this error in the original VSCode window:

stderr:   File "c:\Programs\leointeg/scripts/leobridge.py", line 26

    print(p_string, flush=True)
                         ^
SyntaxError: invalid syntax
leoBridge.js:106

child process exited with code 1
leoBridge.js:109

Looks like it's using Python 2 (which was installed along with Node.js, I didn't have it installed previously).

After adding `C:\Programs\Anaconda3` to my (system) PATH variable before C:\Python27, I get this:

from python Error importing leoApp.py
leoBridge.js:73
stderr: Traceback (most recent call last):
  File "c:\Programs\leointeg/scripts/leobridge.py", line 13, in <module>
    verbose=False)     # True: print informational messages.
  File "C:\Programs\Leo\leo\core\leoBridge.py", line 71, in controller
    verbose)
  File "C:\Programs\Leo\leo\core\leoBridge.py", line 89, in __init__
    self.initLeo()
  File "C:\Programs\Leo\leo\core\leoBridge.py", line 120, in initLeo
    assert(g.app)
AssertionError

leoBridge.js:106
child process exited with code 1

(And still no Load File in Leo's tab).

Maybe with Anaconda we need to use a different way to properly invoke the environment?

I forgot the details of why, but for my cmd shell I use this:

%windir%\System32\cmd.exe "/K" C:\Programs\Anaconda3\Scripts\activate.bat

Arjan

[Matt Wilkie]

Maybe with Anaconda we need to use a different way to properly invoke the environment?

I forgot the details of why, but for my cmd shell I use this:

%windir%\System32\cmd.exe "/K" C:\Programs\Anaconda3\Scripts\activate.bat

 

This will invoke conda's root or base environment but not the one created for project-x. Something more like this (being mindful to balance the quotes):

%windir%\system32\cmd.exe /K ""C:\Miniconda3\Scripts\activate.bat" "C:\Miniconda3\envs\leo-editor" && {any other cmd}"

(Responding just to the conda part. I've not done any of the other things in this thread.)

-matt

[Félix]

@arjan Yep, it wont work with python2, but I can assure you nodejs does not install nor bundle python2 with itself!. Also what version of Leo and python do you have? I made all run under leo 6.0 final (installed from sources git clone --depth=500 https://github.com/leo-editor/leo-editor) and python 3.7.4

I'm asking this because you're getting "Error importing leoApp.py" as your main error message and it's bugging out in initLeo, which is internal to leo, so i'm wondering what Leo version its using...  

@Edward (on windows) those modified 'package' files are getting small modifications when doing 'npm install' because of versions of dependencies getting updates.( Something I overlooked in my explanations. )
 Solution : Revert those files to their original states before doing "git pull" so that git lets you apply updates you pulled... either with "git checkout <file>" in terminal, or throught the git panel of vscode (or your personal/favorite way of reverting a modified file in a gitted project folder) ... or even just wipe and re-clone from scratch but thats a bit radical ;)

@Edward (on ubuntu) thats strange, so far running on ubuntu has been the way that worked 'out of the box'. ...and you're not  getting any errors in the debug console of the original vscode window? is "python3" the way to invoke it on your install of ubuntu? 

@matt : i'm not that familiar with the python world in general and all that anaconda stuff is chineese to me... sorry... i'll try to catch up !

To all testing : I am so very gratefull!!! For windows, it seems That I need to do a much better job at figuring out a reliable way to invoke the 'leobridge.py' script of the leoInteg expansion by making sure that I get a hold of the path to launch with a valid python3 instance on the user's computer! (Because when the leoInteg expansion succeeds in finding valid python3 & leo6.0 it does indeed work) 

(I might also try to figure if I can check that leo '6.0' is installed and reachable before trying to start anything )

So I'm making myself a pot of coffee and will be working on this throughout the 3 day weekend to make it work reliably in at least those 2 OS's! I want to make sure anyone can 'easily' install and run this on linux&windows before adding "REAL" Leo Features ;)

My windows 10 software versions are :

vscode 1.39.1

node 10.16.3

python 3.7.4

leo 6.0 final (installed from git clone)

qt5 installed with "pip3 install PyQt5" 

standard 'vanilla' versions of everything... sensibly the same as under my working ubuntu setup i guess... 

I'll post updates as I go along and figure stuff out - Please do the same if you're so inclined!

A sincere thanks for your time and effort in helping me sorting this stuff out you guys!

--

Félix

[Arjan]

Hmm, I'm sure I saw Python 2.7 getting installed, as well as Chocolatey and one or more MS dependencies, perhaps one of those triggered it. But I was just mentioning that message for completeness.

As for versions:

- VSCode 1.39.1

- Node.JS 12.11.1 -- that seems like the only significant difference, but seems an unlikely cause for the problem?

- Leo 6.0-final (master branch from Git)

- Python 3.7.3 (via Anaconda)

- PyQt version 5.9.6 (installed via `conda install pyqt` -- as far as I remember, and put in my notes, I didn't specify anything further for Qt5 itself).

Cheers,
Arjan

[Félix]

@Arjan Could totally be node 12! maybe its a stretch to think so, but at work we had problems on a bunch of unrelated stuff and using 'LTS' supported version 10 instead of the pre-release 12 fixed it ! ... so I wouldn't be surprised if the beta node 12 was a problem. (node is the engine running all the debug stuff of vscode) might be worth a try to replace node 12 by the more stable node 10 (if its not a major inconvenience for you to try this out)

[Arjan]

I downgraded to Node.JS 10.16.3, but the error remains the same (`from python Error importing leoApp.py`)

I also tried creating a python3.bat file on my PATH, which says `%windir%\system32\cmd.exe /K ""C:\Programs\Anaconda3\Scripts\activate.bat" && %*"`.

Now there's no more errors, but still no "Load File" button. I always forget the correct options for batch files though, maybe this isn't quite right.

[Edward K. Ream]

On Sat, Oct 12, 2019 at 2:02 PM Félix <felix...@gmail.com> wrote:

> @Edward (on windows) those modified 'package' files are getting small modifications when doing 'npm install' because of versions of dependencies getting updates.( Something I overlooked in my explanations. )
 Solution : Revert those files to their original states before doing "git pull" so that git lets you apply updates you pulled...

Did that.  npm install said everything was up to date.

Please me what I should do within VS Code.  I see a LEO and OUTLINE areas, but they don't seem to do much.

I'm confused about F5. Doing F5 in the bottom area puts the cursor in a top area that says Extensions: Select environment.  Selecting node.js gives ${file} can not be resolved. 

Edward

[Félix]

I've rewritten everything during the weekend, I've changed the whole system into a client / server tcp/ip relationship. not polished yet, so i've pushed it on the dev branch before I cleanup and get it merged into master. 

 (gotta cleanup and add buttons and text on the outline bar among other things to make the start process easy and bulletproof)

You may try this new method of the dev branch (before i make it user firendly) if you're so inclined:  you may start the server by running leobridgeserver.py which is at the root of the project folder. (needs websocket dependency: pip install websockets) then start running another instance of vscode with the leointeg expansion running with F5.

In a day or two i'll finish adding buttons to ask for adress and port to connect and facilitate the process in a much needed way, (and then push to master)  but for now, if you want to try it: leointeg will try to connect to localhost on port 32125 : the one set in leointegserver.py defaults constants. just make sure to start the server beforehand.

About F5 : This does not start running and debugging the expansion, rather, it starts to run another instance of vscode with the leointeg expansion activated in it. So doing another F5 in that other vscode window is not recomended, as I dont know upon what workspace it will open into! (may be the last one you worked with in vscode or some other depending on your vscode settings and past usage) 

The workspace it opened into will also trigger all sorts of suggestions about installing tools to code and debug depending on what filetypes are present in this workspace. That may be where that 'extensions select environmen thing' came from, really not sure about that.

Also to be noted, the leointeg expansion in the instance that was started with F5 will 'activate' and show up automatically in the explorer view, if that new 'workspace' contains a leo file. You can also force it to activate by switching to ths 'leo view' by clicking on the leo icon on the far-left sidebar. This one also has an outline view, altough taller as it has the whole left pane to itself. ( i dont start the expansion by default to speed startup on workspaces that would not be used for leo file manipulation, as it add 2 or 3 seconds)

So doing F5 should not be performed other than once to start a debug/run session of a vscode instance with the leointeg expansion enabled in it. 

Of course, when the expansion is more fleshed out, i'll wrap it up in a real expansion bundle, which eliminates all installation procedures into a seamless 'one click'.

--

Too late for me now, gotta go to sleep its past midnight!! - i'll finish making the whole thing into a more professional looking procedure, with a two step process of 'connecting to server' and then 'opening a leo file'  during the week. 

...but if anyone is brave enough, they can try the dev branch.

--

Félix

p.s. Leo rocks!

[Edward K. Ream]

On Mon, Oct 14, 2019 at 11:40 PM Félix <felix...@gmail.com> wrote:

About F5 : ...So doing F5 should not be performed other than once to start a debug/run session of a vscode instance with the leointeg expansion enabled in it. 

Thanks for this clarification.

Your work suggests better ways of integrating Leo with emacs org mode and vim outline mode.  I'll say more later.

Edward

[Félix]

Thank you for your patience,

I'm a bit shaken that I'm having trouble making leointeg startup work flawlessly for anybody, even more so by the creator of Leo itself! 

I'll double up in efforts this week to make it much easier, both in implementation sturdiness and in a graphical interface 'ease of usage'.

I'll then switch all this new work from the dev branch to the master branch.

thanks again and dont hesitate for any questions! 

--

(also, english is not my first language so it might also get in the way) 

Félix

[Edward K. Ream]

On Tue, Oct 15, 2019 at 8:28 AM Félix <felix...@gmail.com> wrote:

I'm a bit shaken that I'm having trouble making leointeg startup work flawlessly for anybody, even more so by the creator of Leo itself! 

I wouldn't worry at all.  I'm a complete VS code newbie.

Installation and documentation issues can take a long time.  We'll all get there...

Edward