update doc

update os.path.isdir to handle windows path better

README.cn.md

@@ -18,7 +18,7 @@ z.lua 是一个快速路径切换工具，它会跟踪你在 shell 下访问过
 - 使用增强匹配算法，更准确的带你去到你想去的地方。
 - 低占用，能够仅在当前路径改变时才更新数据库（将 `$_ZL_ADD_ONCE` 设成 1）。
 - 交互选择模式，如果有多个匹配结果的话，跳转前允许你进行选择。
-- 集成 fzf （可选），可以用来做可视化选择或者 bash 参数补全。
+- 集成 fzf （可选），可以用来做可视化选择或者参数补全。
 - 快速跳转到父目录，或者项目根目录，代替反复 “cd ../../.." 。
 - 兼容 lua 5.1, 5.2 和 5.3 以上版本。
 - 自包含且无额外依赖，单个 `z.lua` 文件完成所有工作。
@@ -263,7 +263,7 @@ PS：你可以使用 `$_ZL_FZF` 环境变量来精确指明 fzf 的可执行路
 
 `"-b"` 选项可以快速回到某一级父目录，避免重复的输入 "cd ../../.."。
 
-- **(没有参数)**：`cd` 到项目根目录，即跳转到父目录中包含 (.git/.svn/.hg) 的地方。
+- **(没有参数)**：`cd` 到项目根目录，即跳转到最近的包含 (.git/.svn/.hg) 的父目录。
 - **(单个参数)**：`cd` 到离当前目录最近的以关键字开头的父目录，如果找不到就尝试跳到包含关键字的父目录。
 - **(两个参数)**：将当前路径中的第一个关键词替换为第二个关键词。
 
@@ -321,27 +321,14 @@ eval "$(lua /path/to/z.lua --init bash enhanced once echo fzf)"
 
 有了 fzf 的帮助，bash 下补全也非常方便了。注意看左边的权重，fzf 搜索过滤的顺序是有讲究的，Frecent 权重越高的越靠前，不是乱排序的，更不是简单的按字符串字母排序。这里完全保证权重越高的路径越靠前。
 
+`z.lua` 可以同 [fz](https://github.com/changyuheng/fz) 协作以提供**更好的补全结果**，详细见 [FAQ](https://github.com/skywind3000/z.lua/wiki/FAQ#fzsh-for-better-completion)。
+
 注意：该功能在初始化 z.lua 之前，会检测 $PATH 中是否有 fzf 这个程序，有的话才启用。
 
 
 ## MRU
 
-以往我们经常使用 `cd -` 命令来回到刚才访问过的目录，而有了 fzf 的帮助，我们可以更高效的来完成这件事情：
-
-
-```bash
-alias zh='z -I -t .'
-```
-
-首先定义个新的别名 `zh`（回到历史路径的意思），我们使用了 `-t` 参数来告诉 `z.lua` 按照时间戳作为权重进行排序，同时 `-I` 启用 fzf 进行搜索，最后的句号代表任意路径。
-
-那么当我们在命令行敲入 zh 时，就可以用 fzf 选择最近呆过的路径了：
-
-![](images/mru.png)
-
-第一列数据代表该路径多少秒以前访问过，第二列是路径名称。此时，你可以试着敲几个字母，用 fzf 的字符串模糊匹配进行定位，或者用光标键的上和下（CTRL+J/K 也可以）来上下移动，最后按回车 cd 过去，或者 ESC 放弃。
-
-版本 `v1.5.1` 引入了模拟 "dir stack" 可以通过： `z -`，`z --` 和 `z -{num}` 来操作:
+`z.lua` 提供 `dirstack` 让你更便捷的访问最近刚刚去过的目录，而不需要输入任何关键字。这个方法叫做 `dirstack`，它记录着最近你刚刚去过的 10 条最新路径，然后是用 `z -`，`z --` 和 `z -{num}` 来操作：
 
 ```bash
 # 显示当前的 dir stack
@@ -361,8 +348,25 @@ $ z -
   => cd -
 ```
 
+这个 `dirstack` 是根据 z.lua 的路径历史数据库计算的出来的，所以和具体的 shell 或者操作系统都没有关系。你退出再登陆不会丢失这些路径历史，不同的 shell 之间也可以共享同一份历史数据。
+
+此外，还有另外一种方法，通过使用前面提到的 `-I` 和 `-t` 参数组和，可以使用 fzf 进行交互式选择：
+
+```bash
+alias zh='z -I -t .'
+```
+
+首先定义个新的别名 `zh`（回到历史路径的意思），我们使用了 `-t` 参数来告诉 `z.lua` 按照时间戳作为权重进行排序，同时 `-I` 启用 fzf 进行搜索，最后的句号代表任意路径。
+
+那么当我们在命令行敲入 zh 时，就可以用 fzf 选择最近呆过的路径了：
+
+![](images/mru.png)
+
+第一列数据代表该路径多少秒以前访问过，第二列是路径名称。此时，你可以试着敲几个字母，用 fzf 的字符串模糊匹配进行定位，或者用光标键的上和下（CTRL+J/K 也可以）来上下移动，最后按回车 cd 过去，或者 ESC 放弃。
+
 注意：最好把增强匹配模式打开，这样查看历史路径时可以把当前路径过滤掉。
 
+
 ## Tips
 
 推荐一些常用的命令别名:
@@ -388,7 +392,7 @@ FN="$HOME/.local/share/autojump/autojump.txt"
 awk -F '\t' '{print $2 "|" $1 "|" 0}' $FN >> ~/.zlua
 ```
 
-
+要更好的使用 `z.lua`，别忘记阅读：[Frequently Asked Questions](https://github.com/skywind3000/z.lua/wiki/FAQ)。
 
 
 ## Benchmark

README.md

@@ -19,10 +19,10 @@ For example, `z foo bar` would match `/foo/bar` but not `/bar/foo`.
 - **10x** times faster than **fasd** and **autojump**, **3x** times faster than **z.sh**.
 - Available for **posix shells**: bash, zsh, dash, sh, ash, ksh, busybox and etc.
 - Available for Fish Shell, Power Shell and Windows cmd.
-- Enhanced matching mode takes you to where ever you want precisely.
+- [Enhanced matching algorithm](#enhanced-matching) takes you to where ever you want precisely.
 - Allow updating database only if `$PWD` changed with "$_ZL_ADD_ONCE" set to 1.
 - Interactive selection enables you to choose where to go before cd.
-- Intergrated with FZF (optional) for interactive selection and bash completion.
+- Intergrated with FZF (optional) for interactive selection and completion.
 - Quickly go back to a parent directory instead of typing "cd ../../..".
 - Corresponding experience in different shells and operating systems. 
 - Compatible with Lua 5.1, 5.2 and 5.3+
@@ -34,7 +34,7 @@ For example, `z foo bar` would match `/foo/bar` but not `/bar/foo`.
 ```bash
 z foo       # cd to most frecent dir matching foo
 z foo bar   # cd to most frecent dir matching foo and bar
-z -r foo    # cd to highest ranked dir matching foo
+z -r foo    # cd to the highest ranked dir matching foo
 z -t foo    # cd to most recently accessed dir matching foo
 z -l foo    # list matches instead of cd
 z -c foo    # restrict matches to subdirs of $PWD
@@ -219,14 +219,14 @@ If no match is found, it will fall back to default matching method.
 
 - Skip the current directory:
 
-  when you are calling `z xxx` but the best match is the current directory, z.lua will choose the 2nd best match result for you. Assuming the database:
+  When you are calling `z xxx` but the best match is the current directory, z.lua will choose the 2nd best match result for you. Assuming the database:
 
       10   /Users/Great_Wall/.rbenv/versions/2.4.1/lib/ruby/gems
       20   /Library/Ruby/Gems/2.0.0/gems
 
   When I use `z gems` by default, it will take me to `/Library/Ruby/Gems/2.0.0/gems`, but it's not what I want, so I press up arrow and execute `z gems` again, it will take me to `/Users/Great_Wall/.rbenv/versions/2.4.1/lib/ruby/gems` and this what I want.
 
-  Of course I can always use `z env gems` to indicate what I want precisely. Skip the current directory means when you use `z xxx` you always want to change directory instead of stay in the same directory and do nothing if current directory is the best match.
+  Of course, I can always use `z env gems` to indicate what I want precisely. Skip the current directory means when you use `z xxx` you always want to change directory instead of stay in the same directory and do nothing if current directory is the best match.
 
 The default matching method is designed to be compatible with original z.sh, but the enhanced matching method is much more handy and exclusive to z.lua.
 
@@ -235,7 +235,7 @@ The default matching method is designed to be compatible with original z.sh, but
 
 By default, z.lua will add current directory to database each time before display command prompt (correspond with z.sh). But there is an option to allow z.lua add path only if current working directory changed.
 
-To enable this, you can set `$_ZL_ADD_ONCE` to `1` before init z.lua. Or you can init z.lua on linux like this:
+To enable this, you can set `$_ZL_ADD_ONCE` to `1` before init z.lua. Or you can initialize z.lua on linux like this:
 
 ````bash
 eval "$(lua /path/to/z.lua --init bash once)"
@@ -243,7 +243,8 @@ eval "$(lua /path/to/z.lua --init zsh once)"
 source (lua /path/to/z.lua --init fish once | psub)
 ````
 
-It could be much faster on slow hardware or Cygwin/MSYS.
+With `add once` mode off (default), z.lua will consider the time you spent in the directory (like z.sh). When this mode is on, consider the times you accessed the directory (like autojump), and that could be much faster on slow hardware. 
+
 
 ## Interactive Selection
 
@@ -261,6 +262,7 @@ And then you can input the number and choose where to go before actual cd. eg. i
 
 NOTE: for fish shell, this feature requires fish 2.7.0 or above.
 
+
 ## FZF Supports
 
 From version 1.1.0, a new option `"-I"` will allow you to use fzf to select when there are multiple matches. 
@@ -273,7 +275,7 @@ Of course, you can always give more keywords to `z` command to match your destin
 
 Usually, `z -I` can be aliased to `zf` (z + fuzzy finder) for convenience. If there are only one path matched, `z -I` will jump to it directly, fzf will only be invoked for multiple matches.
 
-`"z -I ."` or `"zf ."` can be used to use fzf select from entire database.
+`"z -I ."` or `"zf ."` can be used to use fzf select from entire database. Environment variable `_ZL_FZF_FLAG` is for passing additional arguments to fzf.
 
 NOTE: For fish shell, this feature requires fish 2.7.0 or above. You can specify fzf executable in `$_ZL_FZF` environment variable, `"fzf"` will be called by default.
 
@@ -282,8 +284,8 @@ NOTE: For fish shell, this feature requires fish 2.7.0 or above. You can specify
 
 New option `"-b"` can quickly go back to a specific parent directory in bash instead of typing "cd ../../.." redundantly.
 
-- **(No argument)**: `cd` into the project root, the project root is one of the parent directory with `.git`/`.hg`/`.svn` in it
-- **(One argument)**: `cd` into the closest parent starting with keyword, if not find, goto the parent containing keyword.
+- **(No argument)**: `cd` into the project root, the project root the nearest parent directory with `.git`/`.hg`/`.svn` in it
+- **(One argument)**: `cd` into the closest parent starting with keyword, if not find, go to the parent containing keyword.
 - **(Two arguments)**: replace the first value with the second one (in the current path).
 
 Let's start by aliasing `z -b` to `zb`:
@@ -337,27 +339,16 @@ Then press `<tab>` after `z xxx`:
 
 ![](images/complete-2.png)
 
-With the help of fzf, completion in bash is much easier now.
+With the help of fzf, completion in bash is much easier now. 
+
+`z.lua` can cooperate with [fz](https://github.com/changyuheng/fz) for **better completion** result in both bash and zsh, for more information see [FAQ](https://github.com/skywind3000/z.lua/wiki/FAQ#fzsh-for-better-completion).
 
 NOTE: To enable this, command `fzf` must be found in `$PATH` before initialization.
 
+
 ## Most Recently Accessed Path
 
-We always use `cd -` to go back to last accessed directory, but with the help of `fzf` we can achieve this productively:
-
-```bash
-alias zh='z -I -t .'
-```
-
-The new alias `zh` (jump to history) uses a parameter `-t` to sort the result by time and `-I` to use `fzf` for selection. the result is:
-
-![](images/mru.png)
-
-The first column indicates how many seconds ago you have visited, and the second column is the path name. With `zh`, you can type some character to use string matching in fzf, or use `<Up>`/`<Down>` (as well as `CTRL+j/k`) to move the selector (red `>`) up and down. 
-
-At last, press `<enter>` to accept or `<ESC>` to give up. 
-
-Version `v1.5.1` has introduced a simulated "dir stack", which can be manipulated by `z -`, `z --` and `z -{num}`:
+`z.lua` provides a fast way to visit MRU directories without typing any keyword. That is `dirstack`, which records recently visited paths and can be manipulated by `z -`, `z --` and `z -{num}`:
 
 ```bash
 # display current dir stack
@@ -377,6 +368,22 @@ $ z -
   => cd -
 ```
 
+The `dirstack` is calculated from z.lua's database, and has no dependency on shells or systems. You will not lost records after re-login, and history can be shared across shells and sessions.
+
+There is another way to access MRU directories interactively by utilizing parameter `-I` (fzf) and `-t` (sort by time):
+
+```bash
+alias zh='z -I -t .'
+```
+
+The new alias `zh` (jump to history) is very easy to input:
+
+![](images/mru.png)
+
+The first column indicates how many seconds ago you have visited, and the second column is the path name. With `zh`, you can type some character to use string matching in fzf, or use `<Up>`/`<Down>` (as well as `CTRL+j/k`) to move the selector (red `>`) up and down. 
+
+At last, press `<enter>` to accept or `<ESC>` to give up. 
+
 Remember to enable the [enhanced matching](#enhanced-matching) algorithm, the current working directory can be skipped with it.
 
 
@@ -386,8 +393,8 @@ Remember to enable the [enhanced matching](#enhanced-matching) algorithm, the cu
 Recommended aliases you may find useful:
 
 ```bash
-alias zc='z -c'      # restrict matches to subdirs of $PWD
-alias zz='z -i'      # cd with interactive selection
+alias zz='z -c'      # restrict matches to subdirs of $PWD
+alias zi='z -i'      # cd with interactive selection
 alias zf='z -I'      # use fzf to select in multiple matches
 alias zb='z -b'      # quickly cd to the parent directory
 ```
@@ -406,11 +413,12 @@ FN="$HOME/.local/share/autojump/autojump.txt"
 awk -F '\t' '{print $2 "|" $1 "|" 0}' $FN >> ~/.zlua
 ```
 
+Don't forget to read the [Frequently Asked Questions](https://github.com/skywind3000/z.lua/wiki/FAQ).
 
 
 ## Benchmark
 
-The slowest part is adding path to history data file. It will run every time when you press enter (installed in $PROMPT_COMMAND). so I profile it on my nas:
+The slowest part is adding path to history data file. It will run every time when you press enter (installed in $PROMPT_COMMAND). So I profile it on my NAS:
 
 ```bash
 $ time autojump --add /tmp
@@ -448,6 +456,9 @@ As you see, z.lua is the fastest one and requires less resource.
 
 ## History
 
+- 1.5.4 (2019-02-19): fixed: file/path existence detection fails on read-only fs (closed [#49](https://github.com/skywind3000/z.lua/issues/49) by [@contrun](https://github.com/contrun)).
+- 1.5.3 (2019-02-17): new `$_ZL_FZF_FLAG` for passing additional flags to fzf, add `-e` argument to fzf.
+- 1.5.2 (2019-02-16): be aware of all arguments in fzf completion.
 - 1.5.1 (2019-02-15): new: simulated dir stack by `z -`, `z --` and `z -{num}`.
 - 1.5.0 (2019-02-14): fixed minor issues in backward jumping.
 - 1.4.7 (2019-02-13): Don't use regex in backward jumping (use plain text instead).

z.lua

@@ -4,7 +4,7 @@
 -- z.lua - a cd command that learns, by skywind 2018, 2019
 -- Licensed under MIT license.
 --
--- Version 1.5.1, Last Modified: 2019/02/15 11:26
+-- Version 1.5.4, Last Modified: 2019/02/19 11:18
 --
 -- * 10x faster than fasd and autojump, 3x faster than z.sh
 -- * available for posix shells: bash, zsh, sh, ash, dash, busybox
@@ -158,6 +158,10 @@ function string:startswith(text)
 	return false
 end
 
+function string:endswith(text)
+	return text == "" or self:sub(-#text) == text
+end
+
 function string:lstrip()
 	if self == nil then return nil end
 	local s = self:gsub('^%s+', '')
@@ -418,6 +422,8 @@ end
 function os.path.isdir(pathname)
 	if pathname == '/' then
 		return true
+	elseif pathname == '' then
+		return false
 	elseif windows then
 		if pathname == '\\' then
 			return true
@@ -425,15 +431,11 @@ function os.path.isdir(pathname)
 			return true
 		end
 	end
-	local name = pathname .. '/'
-	local ok, err, code = os.rename(name, name)
-	if not ok then
-		if code == 13 then
-			return true
-		end
-		return false
+	local name = pathname
+	if (not name:endswith('/')) and (not name:endswith('\\')) then
+		name = name .. '/'
 	end
-	return true
+	return os.path.exists(name)
 end
 
 
@@ -445,6 +447,12 @@ function os.path.exists(name)
 	if not ok then
 		if code == 13 then
 			return true
+		elseif code == 30 then
+			local f = io.open(name,"r")
+			if f ~= nil then
+				io.close(f)
+				return true
+			end
 		end
 		return false
 	end
@@ -757,6 +765,37 @@ function os.scriptname()
 end
 
 
+-----------------------------------------------------------------------
+-- get environ
+-----------------------------------------------------------------------
+function os.environ(name, default)
+	local value = os.getenv(name)
+	if value == nil then
+		return default
+	elseif type(default) == 'boolean' then
+		value = value:lower()
+		if value == '0' or value == '' or value == 'no' then
+			return false
+		elseif value == 'false' or value == 'n' or value == 'f' then
+			return false
+		else
+			return true
+		end
+	elseif type(default) == 'number' then
+		value = tonumber(value)
+		if value == nil then 
+			return default 
+		else
+			return value
+		end
+	elseif type(default) == 'string' then
+		return value
+	elseif type(default) == 'table' then
+		return value:sep(',')
+	end
+end
+
+
 -----------------------------------------------------------------------
 -- parse option
 -----------------------------------------------------------------------
@@ -1235,13 +1274,14 @@ function z_match(patterns, method, subdir)
 	subdir = subdir ~= nil and subdir or false
 	local M = data_load(DATA_FILE)
 	M = data_select(M, patterns, false)
+	M = data_filter(M)
 	if Z_MATCHNAME then
 		local N = data_select(M, patterns, true)
+		N = data_filter(N)
 		if #N > 0 then
 			M = N
 		end
 	end
-	M = data_filter(M)
 	M = data_update_frecent(M)
 	if method == 'time' then
 		current = os.time()
@@ -1294,7 +1334,7 @@ end
 -----------------------------------------------------------------------
 function z_print(M, weight, number)
 	local N = {}
-	local maxsize = 10
+	local maxsize = 9
 	local numsize = string.len(tostring(#M))
 	for _, item in pairs(M) do
 		local record = {}
@@ -1406,19 +1446,20 @@ function z_cd(patterns)
 		end
 		retval = M[index].name
 	elseif Z_INTERACTIVE == 2 then
-		local fzf = os.getenv('_ZL_FZF')
+		local fzf = os.environ('_ZL_FZF', 'fzf')
 		local tmpname = '/tmp/zlua.txt'
-		local cmd = '--nth 2.. --reverse --inline-info +s --tac'
-		local cmd = ((not fzf) and 'fzf' or fzf)  .. ' ' .. cmd
+		local cmd = '--nth 2.. --reverse --inline-info +s --tac -e'
+		cmd = ((fzf == '') and 'fzf' or fzf)  .. ' ' .. cmd
+		cmd = cmd .. ' ' .. os.environ('_ZL_FZF_FLAG', '') .. ' '
 		if not windows then
 			tmpname = os.tmpname()
-			if not os.getenv('_ZL_FZF_FULLSCR') then
+			if not os.environ('_ZL_FZF_FULLSCR', false) then
 				cmd = cmd .. ' --height 35%'
 			end
 			cmd = cmd .. ' < "' .. tmpname .. '"'
 		else
 			tmpname = os.tmpname():gsub('\\', ''):gsub('%.', '')
-			tmpname = os.getenv('TMP') .. '\\zlua_' .. tmpname .. '.txt'
+			tmpname = os.environ('TMP', '') .. '\\zlua_' .. tmpname .. '.txt'
 			cmd = 'type "' .. tmpname .. '" | ' .. cmd
 		end
 		PRINT_MODE = tmpname
@@ -1710,7 +1751,7 @@ function z_init()
 			table.insert(Z_EXCLUDE, name)
 		end
 	end
-	if _zl_cmd ~= nil then
+	if _zl_cmd ~= nil and _zl_cmd ~= '' then
 		Z_CMD = _zl_cmd
 	end
 	if _zl_matchname ~= nil then
@@ -1740,7 +1781,7 @@ end
 -- initialize clink hooks
 -----------------------------------------------------------------------
 function z_clink_init()
-	local once = os.getenv("_ZL_ADD_ONCE")
+	local once = os.environ("_ZL_ADD_ONCE", false)
 	local previous = ''
 	function z_add_to_database()
 		pwd = clink.get_cwd()
@@ -1900,8 +1941,7 @@ if [ "$TERM" != "dumb" ] && command -v fzf >/dev/null 2>&1; then
 	# To redraw line after fzf closes (printf '\e[5n')
 	bind '"\e[0n": redraw-current-line'
 	_zlua_fzf_complete() {
-		local query="${COMP_WORDS[COMP_CWORD]}"
-		local selected=$(_zlua | sed "s|$HOME|\~|" | $zlua_fzf --query "$query" | sed 's/^[0-9,.]* *//')
+		local selected=$(_zlua -l "${COMP_WORDS[@]:1}" | sed "s|$HOME|\~|" | $zlua_fzf | sed 's/^[0-9,.]* *//')
 		if [ -n "$selected" ]; then
 			COMPREPLY=( "$selected" )
 		fi
@@ -1941,12 +1981,12 @@ function z_shell_init(opts)
 		print(script)
 	end
 
-	local prompt_hook = (os.getenv("_ZL_NO_PROMPT_COMMAND") == nil)
-	local once = (os.getenv("_ZL_ADD_ONCE") ~= nil) or opts.once ~= nil
+	local prompt_hook = (not os.environ("_ZL_NO_PROMPT_COMMAND", false))
+	local once = os.environ("_ZL_ADD_ONCE", false) or opts.once ~= nil
 
 	if opts.bash ~= nil then
 		if prompt_hook then
-			if opts.once then
+			if once then
 				print(script_init_bash_once)
 			elseif opts.fast then
 				print(script_init_bash_fast)
@@ -1956,10 +1996,11 @@ function z_shell_init(opts)
 		end
 		print(script_complete_bash)
 		if opts.fzf ~= nil then
-			fzf_cmd = "fzf --nth 2 --reverse --inline-info +s --tac"
-			if not os.getenv('_ZL_FZF_FULLSCR') then
+			fzf_cmd = "fzf --nth 2 --reverse --inline-info +s --tac -e"
+			if not os.environ('_ZL_FZF_FULLSCR', false) then
 				fzf_cmd = fzf_cmd .. ' --height 35%'
 			end
+			fzf_cmd = fzf_cmd .. ' ' .. os.environ('_ZL_FZF_FLAG', '') .. ' '
 			print('zlua_fzf="' .. fzf_cmd .. '"')
 			print(script_fzf_complete_bash)
 		end

z.lua.plugin.zsh

@@ -20,6 +20,7 @@ if [[ -z "$ZLUA_EXEC" ]]; then
 	fi
 fi
 
+export _ZL_FZF_FLAG="-e"
 
 eval "$($ZLUA_EXEC $ZLUA_SCRIPT --init zsh once enhanced)"