clink.lua updates #2860

daxgames · 2023-07-09T00:13:06Z

Changes from #2856 and #2859

Adds

`%cmder_root%\vendor\clink.lua
- Comments to explain some of less than clear purpose of some code.
- Set global variable CMDER_CONFIG_PATH=%CMDER_ROOT%\config.
- Set global variable CMDER_USER_CONFIG_PATH to the value of env var '%CMDER_USER_CONFIG%' IF is is set else nil.
- Wrap gsub args 2 and 3 with verbatim()

….24, clink-completions v0.4.7)

Updates to `3` vendored dependencies

daxgames · 2023-07-09T00:34:36Z

@chrisant996 I am not a lua dev so be gentle. :-)

I think I captured what you were talking about #2859 and #2856.

chrisant996 · 2023-07-10T04:32:10Z

vendor/clink.lua

 ---
 -- Global variable so other Lua scripts can detect whether they're in a Cmder
 -- shell session.
 ---
 CMDER_SESSION = true
+CMDER_CONFIG_PATH = clink.get_env('CMDER_ROOT')..'\\config'


I meant factor the environment variables in init.bat, not in clink.lua.

chrisant996 · 2023-07-10T04:42:38Z

vendor/clink.lua

 end

 local function percent_prompt_filter()
-    clink.prompt.value = string.gsub(clink.prompt.value, "{percent}", "%%")
+    clink.prompt.value = string.gsub(clink.prompt.value, verbatim("{percent}"), verbatim("%%"))


The %% was already escaped.
Using verbatim("%%") turns into "%%%%", i.e. two percent signs.
The goal was one percent sign.
So this would need to be verbatim("%").

But even safer and simpler would be this:

clink.prompt.value = gsub_plain(clink.prompt.value, "{percent}", "%")

After adding the gsub_plain() function I was suggesting:

local function gsub_plain(str, find, replace) return string.gsub(str, verbatim(find), verbatim(replace)) end

And then people can use gsub_plain() instead of string.gsub(). And then it's simple to use, and simple to review. Any time a call to string.gsub() is seen being added, it's easy to review it and assess whether the intent is a plain string replacement, or a Lua pattern replacement (which is similar to regular expressions, but not quite the same). Any plain string replacements should use gsub_plain() instead.

chrisant996 · 2023-07-10T04:45:43Z

vendor/clink.lua

+-- If Cmder is launched with '/c [folderPath]' indicating Cmder is installed globally and
+-- each user has a private '[folderPath]\config' folder. 
+---
+CMDER_USER_CONFIG_PATH = nil


I meant to set environment variables in init.bat, and then in clink.lua use the environment variables.

Setting global Lua variables isn't needed, and introduces the opportunity for the global Lua variables and the environment variables to get out of sync (making troubleshooting very hard).

chrisant996 · 2023-07-10T04:50:57Z

vendor/clink.lua

@@ -532,13 +543,13 @@ local function git_prompt_filter()
                color = colors.conflict
            end

-            clink.prompt.value = string.gsub(clink.prompt.value, "{git}", " "..color.."("..verbatim(branch)..")")
+            clink.prompt.value = string.gsub(clink.prompt.value, verbatim("{git}"), verbatim(" "..color.."("..verbatim(branch)..")"))


That nests calls to verbatim(), and it will double-escape the percent signs, which will mess them up.

It's one of the reasons I'm suggesting to create a gsub_plain() function. Then you don't have to manually figure out the right syntax for every separate gsub calling location.

Then you can write the lines in a much more intuitively readable manner.

clink.prompt.value = gsub_plain(clink.prompt.value, "{git}", " "..color.."("..branch..")")

chrisant996 · 2023-07-10T04:51:37Z

vendor/clink.lua

@@ -577,13 +588,13 @@ local function hg_prompt_filter()
            end

            local result = color .. "(" .. branch .. ")"
-            clink.prompt.value = string.gsub(clink.prompt.value, "{hg}", " "..verbatim(result))
+            clink.prompt.value = string.gsub(clink.prompt.value, verbatim("{hg}"), verbatim(" "..verbatim(result)))


This nested verbatim calls. That will mess things up.

clink.prompt.value = gsub_plain(clink.prompt.value, "{hg}", " "..result)

And so on, for the other string.gsub() calls further below.

chrisant996 · 2023-07-10T04:52:30Z

vendor/clink.lua

@@ -153,7 +164,7 @@ local function set_prompt_filter()
    end

    if prompt_useHomeSymbol and string.find(cwd, clink.get_env("HOME")) then
-        cwd = string.gsub(cwd, clink.get_env("HOME"), prompt_homeSymbol)
+        cwd = string.gsub(cwd, verbatim(clink.get_env("HOME")), verbatim(prompt_homeSymbol))


cwd = gsub_plain(cwd, clink.get_env("HOME"), prompt_homeSymbol)

chrisant996 · 2023-07-10T04:53:20Z

vendor/clink.lua

+    prompt = string.gsub(prompt, verbatim("{uah}"), verbatim(uah))
+    prompt = string.gsub(prompt, verbatim("{cwd}"), verbatim(cwd))
+    prompt = string.gsub(prompt, verbatim("{env}"), verbatim(env))
+    clink.prompt.value = string.gsub(prompt, verbatim("{lamb}"), verbatim(prompt_lambSymbol))


prompt = gsub_plain(prompt, "{uah}", uah) prompt = gsub_plain(prompt, "{cwd}", cwd) prompt = gsub_plain(prompt, "{env}", env) clink.prompt.value = gsub_plain(prompt, "{lamb}", prompt_lambSymbol)

chrisant996 · 2023-07-10T04:54:57Z

vendor/clink.lua

            return false
        end
    end

    -- No git present or not in git file
-    clink.prompt.value = string.gsub(clink.prompt.value, "{git}", "")
+    clink.prompt.value = string.gsub(clink.prompt.value, verbatim("{git}"), verbatim(""))


clink.prompt.value = gsub_plain(clink.prompt.value, "{git}", "")

chrisant996 · 2023-07-10T05:00:48Z

vendor/clink.lua

+-- 'CMDER_CONFIG_PATH` dir, so we need to load scripts from there before Clink loads lua 
+-- scripts from the profile directory given to it when it was injected.
+---
+if not (isempty(CMDER_USER_CONFIG_PATH)) then


I would recommend to add the comment, but don't change the code to use global Lua variables. Using environment variables here is good.

I was recommending to add another environment variable in init.bat such as set CMDER_DEFAULT_CONFIG_DIR=%CMDER_ROOT%\config, and then use %CMDER_DEFAULT_CONFIG_DIR% in all the places instead of %CMDER_ROOT%\config.

daxgames · 2023-07-10T11:02:25Z

WOW! I thought I understood, did not know it was possible to be so wrong. :-)

Closed this and will revisit.

chrisant996 · 2023-07-10T14:33:25Z

No worries! 😁

chrisant996 · 2023-07-10T15:00:34Z

@daxgames Oh, tell you what -- I will make a PR for the verbatim part.

While working on the git_prompt.lua change to use async prompt filtering, I realized there's more that needs to happen for the verbatim part. In the replace param only % needs to be escaped, but in the find param several other characters also need to be escaped.

I'll make a fix for git_prompt.lua slowness in clink-completions, and then I'll make a PR for the verbatim change in cmder.

daxgames and others added 7 commits April 19, 2023 13:44

⬆️ Update dependencies (git-for-windows v2.40.0.windows.1, clink v1.4…

a4ea326

….24, clink-completions v0.4.7)

Merge pull request #12 from daxgames/update-vendor

5e3b703

Updates to `3` vendored dependencies

Merge branch 'master' of https://github.com/cmderdev/cmder

47258fb

Merge remote-tracking branch 'upstream/master'

ad804ed

add CMDER_CONFIG_PATH and CMDER_USER_CONFIG_PATH to vendor/clink.lua

df244f7

cleanup

4d7e7ea

cleanup

a79cd0a

daxgames changed the title ~~Clink updates~~ clink.lua updates Jul 9, 2023

add verbatim

f89bdd8

chrisant996 reviewed Jul 10, 2023

View reviewed changes

daxgames closed this Jul 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

clink.lua updates #2860

clink.lua updates #2860

daxgames commented Jul 9, 2023 •

edited

Loading

daxgames commented Jul 9, 2023 •

edited

Loading

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

chrisant996 Jul 10, 2023

daxgames commented Jul 10, 2023 •

edited

Loading

chrisant996 commented Jul 10, 2023

chrisant996 commented Jul 10, 2023

clink.lua updates #2860

clink.lua updates #2860

Conversation

daxgames commented Jul 9, 2023 • edited Loading

Changes from #2856 and #2859

Adds

daxgames commented Jul 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daxgames commented Jul 10, 2023 • edited Loading

chrisant996 commented Jul 10, 2023

chrisant996 commented Jul 10, 2023

daxgames commented Jul 9, 2023 •

edited

Loading

daxgames commented Jul 9, 2023 •

edited

Loading

daxgames commented Jul 10, 2023 •

edited

Loading