Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-02 20:20:05 +08:00
Code Issues Projects Releases Wiki Activity

docs(logger): update doc of logger functions

Browse Source
This commit is contained in:
wsdjeg 2023-04-03 23:43:42 +08:00
parent de6efc650c
commit b830d06ef6
2 changed files with 40 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
autoload/SpaceVim/logger.vim
View File

@ -14,7 +14,8 @@ if has('nvim-0.5.0')
\ require("spacevim").eval("a:msg")
\ )
endfunction
""
" write warning message to spacevim runtime log.
function! SpaceVim#logger#warn(msg, ...) abort
let issilent = get(a:000, 0, 1)
lua require("spacevim.logger").warn(
@ -23,24 +24,30 @@ if has('nvim-0.5.0')
\ )
endfunction
""
" write error message to spacevim runtime log.
function! SpaceVim#logger#error(msg) abort
lua require("spacevim.logger").error(
\ require("spacevim").eval("a:msg")
\ )
endfunction
""
" write debug message to spacevim runtime log.
function! SpaceVim#logger#debug(msg) abort
lua require("spacevim.logger").debug(
\ require("spacevim").eval("a:msg")
\ )
endfunction
""
" This a a function to view the spacevim runtime log. same as
" |:SPRuntimeLog| and `SPC h L`
function! SpaceVim#logger#viewRuntimeLog() abort
lua require("spacevim.logger").viewRuntimeLog()
endfunction
""
" Print the debug information of spacevim, same as |:SPDebugInfo|
function! SpaceVim#logger#viewLog(...) abort
if a:0 >= 1
let bang = get(a:000, 0, 0)
@ -49,11 +56,14 @@ if has('nvim-0.5.0')
return luaeval('require("spacevim.logger").viewLog()')
endif
endfunction
""
" change the logger level of spacevim runtime log.
function! SpaceVim#logger#setLevel(level) abort
lua require("spacevim.logger").setLevel(require("spacevim").eval("a:level"))
endfunction
""
" change the output file of spacevim runtime logger. default is empty
" string.
function! SpaceVim#logger#setOutput(file) abort
lua require("spacevim.logger").setOutput(require("spacevim").eval("a:file"))
endfunction
@ -66,6 +76,7 @@ if has('nvim-0.5.0')
" 4. debug(msg): write debug message run SpaceVim runtime log
" 5. start_debug(): enable debug mode of derived logger.
" 6. stop_debug(): stop debug mode of derived logger.
" 7. debug_enabled(): return true or false.
"
" Example: >
" let s:LOGGER = SpaceVim#logger#derive('myplug')

23
doc/SpaceVim.txt
View File

@ -1648,6 +1648,28 @@ SpaceVim#layers#load({layer}) *SpaceVim#layers#load()*
SpaceVim#logger#info({msg}) *SpaceVim#logger#info()*
write message to SpaceVim runtime log with `info` level.
SpaceVim#logger#warn({msg}) *SpaceVim#logger#warn()*
write warning message to spacevim runtime log.
SpaceVim#logger#error({msg}) *SpaceVim#logger#error()*
write error message to spacevim runtime log.
SpaceVim#logger#debug({msg}) *SpaceVim#logger#debug()*
write debug message to spacevim runtime log.
SpaceVim#logger#viewRuntimeLog() *SpaceVim#logger#viewRuntimeLog()*
This a a function to view the spacevim runtime log. same as |:SPRuntimeLog|
and `SPC h L`
SpaceVim#logger#viewLog() *SpaceVim#logger#viewLog()*
Print the debug information of spacevim, same as |:SPDebugInfo|
SpaceVim#logger#setLevel({level}) *SpaceVim#logger#setLevel()*
change the logger level of spacevim runtime log.
SpaceVim#logger#setOutput({file}) *SpaceVim#logger#setOutput()*
change the output file of spacevim runtime logger. default is empty string.
SpaceVim#logger#derive({name}) *SpaceVim#logger#derive()*
Derive a new logger based on SpaceVim's runtime logger. The new logger
provides following functions:
@ -1657,6 +1679,7 @@ SpaceVim#logger#derive({name}) *SpaceVim#logger#derive()*
4. debug(msg): write debug message run SpaceVim runtime log
5. start_debug(): enable debug mode of derived logger.
6. stop_debug(): stop debug mode of derived logger.
7. debug_enabled(): return true or false.
Example:
>