load messages feature to accomodate for overrides by Noice and

the like plugins

fixed buffer delete bug

improved stacktrace

Author: YaroSpace

README.md

@@ -1,22 +1,27 @@
 # 💻 Lua console
 
 **lua-console.nvim** is yet another REPL console to execute Lua, configure Neovim, explore its API and settings.  
-Acts as a user friendly replacement of Command mode - Messages loop. 
+Acts as a user friendly replacement of command mode - messages loop and as a handy scratch pad to store and test code gists.
+
+<img src="doc/demo.gif">
 
 ## 💡 Motivation
 
-After installing Neovim, it took me some time to configure it, learn its settings, structure and API, while learning Lua in the process. 
-I got fed up of constantly hitting `:`, typing `lua= command`, then typing `:messages` to see the output, only to find out that a made a typo or a syntax error and retyping the whole thing again, copying the paths from error stacktraces and so on.  I needed something better, so there it is.
+After installing Neovim, it took me some time to configure it, learn its settings, structure and API, while learning Lua in the process.  
+I got fed up of constantly hitting `:`, typing `lua= command`, then typing `:messages` to see the output, only to find out that a made a typo or a 
+syntax error and retyping the whole thing again, copying the paths from error stacktraces and so on.  I needed something better, so there it is.
 
 ## ✨ Features
 
 - Evaluate single line expressions
 - Evaluate visually selected lines of code
-- Pretty print Lua objects, including function details and their source path
+- Pretty print Lua objects, including function details and their source paths
 - Show normal and error output in the console, including output of print(), errors and stacktraces. 
 - Syntax highlighting and autocompletion
-- Load Neovim’s messages into console
+- Load Neovim’s messages into console for inspection and copy/paste
+- Open links from stacktraces and function sources
 - Save / Load console session
+- Use as scratch pad for code gists
 
 
 ## 📦 Installation
@@ -29,7 +34,8 @@ return {
   lazy = true, keys = "`", opts = {},
 }
 ```
-otherwise: `require('lua-console').setup({opts})`
+otherwise, install with your favourite package manager and add
+`require('lua-console').setup({opts})` somewhere in your config.
 
 
 ## ⚙️  Configuration
@@ -41,7 +47,7 @@ opts = {
   buffer = {
     prepend_result_with = '=> ',
     save_path = vim.fn.stdpath('state') .. '/lua-console.lua',
-    load_on_start = true -- load saved session on first entry
+    load_on_start = true -- load saved session on Vim start
   },
   window = {
     -- @field height number Percentage of main window
@@ -50,7 +56,7 @@ opts = {
   },
   mappings = {
     toggle = '`',
-    eval = '<CR>',  -- or <C-J> for <C-Enter>
+    eval = '<CR>',
     clear = 'C',
     messages = 'M',
     save = 'S',
@@ -63,10 +69,10 @@ opts = {
 
 - Install, hit the mapped key `` ` `` and start exploring. 
 - Enter code as normal, in insert mode.
-- Hit `Enter` in normal mode to evaluate a variable or an expression in the current line. 
+- Hit `Enter` in normal mode to evaluate a variable, statement or an expression in the current line. 
 - Visually select a range of lines and press `Enter` to evaluate the code in the range. 
+- The evaluation of the last line is returned and printed, so no `return` is needed in most cases.
 - Use `print()` in your code to output the result into the console.  Objects and functions are pretty printed. 
-- Use `return …` at the end of multiline code to return a result instead of nil. 
 - Press `M` to load Neovim messages into the console. 
 - Press `gf` to follow the paths in stack traces and to function sources. 
 - Use `S` and `L` to save / load the console session to preserve history of your hacking.