Skip to content

Instantly share code, notes, and snippets.

@ujihisa
Created July 5, 2011 04:43
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ujihisa/1064259 to your computer and use it in GitHub Desktop.
Save ujihisa/1064259 to your computer and use it in GitHub Desktop.
diff --git a/doc/quickrun.jax b/doc/quickrun.jax
index 4faf6c1..1343775 100644
--- a/doc/quickrun.jax
+++ b/doc/quickrun.jax
@@ -1,7 +1,10 @@
*quickrun.txt* コマンドを素早く実行します。
Version: 0.5.0
-Author : thinca <thinca+vim@gmail.com>
+Author: thinca <thinca+vim@gmail.com>
+英訳:
+ * tyru <tyru.exe@gmail.com>
+ * ujihisa <ujihisa at gmail com>
License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
<http://creativecommons.org/licenses/by/2.1/jp/>
@@ -368,7 +371,7 @@ quickrun のいくつかの部分はモジュール化されています。モ
モジュール名に指定する
----------------------
-オプションにモジュール名を指定する際に、オプションの値を指定することができま
+コマンドラインオプションにモジュール名を指定する際に、オプションの値を指定することができま
す。オプションはモジュール名の後に任意の記号を続け、その記号でオプションを区切
ります。各オプションは name=value の形式で指定します。
>
diff --git a/doc/quickrun.txt b/doc/quickrun.txt
index f8f99fd..81d7e06 100644
--- a/doc/quickrun.txt
+++ b/doc/quickrun.txt
@@ -1,8 +1,10 @@
*quickrun.txt* Run a command and show its result quickly.
-Version: 0.4.7
-Author : thinca <thinca+vim@gmail.com>
-Eng[rl]ish document by: tyru <tyru.exe@gmail.com>
+Version: 0.5.0
+Author: thinca <thinca+vim@gmail.com>
+English document by:
+ * tyru <tyru.exe@gmail.com>
+ * ujihisa <ujihisa at gmail com>
License: Creative Commons 2.1 Japanese
<http://creativecommons.org/licenses/by/2.1/jp/>
@@ -18,6 +20,15 @@ OPTIONS |quickrun-options|
OPTION SYNTAX |quickrun-syntax-option|
FORMAT OF EXEC |quickrun-exec-format|
SETTINGS |quickrun-settings|
+MODULE |quickrun-module|
+ RUNNER |quickrun-module-runner|
+ OUTPUTTER |quickrun-module-outputter|
+CREATE MODULE |quickrun-create-module|
+ REGISTER MODULE |quickrun-register-module|
+ SESSION |quickrun-session|
+ MODULE COMMON ATTRIBUTES |quickrun-module-attributes|
+ RUNNER ATTRIBUTES |quickrun-runner-attributes|
+ OUTPUTTER ATTRIBUTES |quickrun-outputter-attributes|
CHANGELOG |quickrun-changelog|
@@ -154,10 +165,6 @@ or |g:quickrun_no_default_key_mappings| has been set to 1.
==============================================================================
OPTIONS *quickrun-options*
-NOTE: Currently this section explains about |quickrun| version 0.4.7 or
- older. |quickrun| version 0.5.0 OPTION system is very different to
- 0.4.7.
-
Here are the list of options you can specify at command-line.
|g:quickrun_config| is used for options which are not specified.
See |quickrun-syntax-option| for options with (*).
@@ -191,79 +198,13 @@ input (*) *quickrun-option-input*
If first character starts with =,
quickrun treats continued string as input.
-output (*) *quickrun-option-output*
- Output format.
- - If you specify empty string, quickrun opens output
- buffer and displays to the output buffer.
- If output buffer already exists, quickrun uses it.
- And for customize, quickrun sets "quickrun" to
- 'filetype' of this buffer.
- - If you specify !, quickrun executes at shell
- directly.
- - If you specify :, quickrun outputs to
- |hit-enter-prompt|. append is not 0, output is
- stored in |message-history|.
- - If you specify ={var}, quickrun outputs to {var}'s
- variable, option, environment variable.
- - If you specify _, quickrun does not output.
- - Otherwise, quickrun outputs to file.
-
-append *quickrun-option-append*
- If this value is not 0,
- (If possile) Append to the output.
-
-runmode *quickrun-option-runmode*
- This value is one of the followings:
- NOTE: other choices except "simple" may be unstable.
- - "simple"
- Use |system()| or (when output is ":") |:!|
- for execute. This is default value.
- - "async:vimproc[:{updatetime}]"
- {You need |vimproc| and |vimshell|}
- Run command asynchronously using |vimproc|.
- Polling the process exit with |CursorHold| and
- |CursorHoldI|. If optional argument {updatetime} is
- given, change 'updatetime' value while the process
- lives. If the process exits within 50 milliseconds,
- shows the result instantly.
- - "async:remote"
- {You need Vim compiled with |+clientserver|}
- Execute commands in background.
- Notify the end of process using |+clientserver|
- and display the result.
- |v:servername| must be set.
- Or not, you need to restart Vim with |--servername|
- option. Note that quickrun can't handle infinite
- loop or input block because this works in
- background.
- - "async:remote:vimproc"
- {You need |vimproc|}
- Use |vimproc| for execute.
- If you tried to execute
- when you have already executed,
- old command will be canceled.
- If you have not installed |vimproc|,
- behave like "simple".
- - "async:python"
- {You need |+python|}
- Run command asynchronously using Python's thread.
- NOTE: this is unstable.
- NOTE: Do not use under X11 environment.
- Vim probably segfaults.
-
-split (*) *quickrun-option-split*
- Helper command to open output buffer.
- This command is invoked before |:split|.
- You can also specify the command using |:tab|, but it
- is not recommended.
- Because if there is no buffer in opened tabpage,
- quickrun opens new output buffer.
- Default value is
- '{winwidth(0) * 2 < winheight(0) * 5 ? "" : "vertical"}'.
-
-into *quickrun-option-into*
- If this value is not 0, Move cursor to output buffer
- when the result is displayed.
+outputter *quickrun-option-outputter*
+ Specifies an outputter. See the details in
+ |quickrun-outputter|.
+
+runner *quickrun-option-runner*
+ Specifies a runner. See the details in
+ |quickrun-runner|.
mode *quickrun-option-mode*
This value is one of n, v, o .
@@ -311,11 +252,6 @@ eval_template *quickrun-option-eval_template*
Template for eval.
quickrun substitutes %s with src.
-running_mark (*) *quickrun-option-running_mark*
- If this value is not empty string,
- quickrun displays this string to output buffer.
- Default value is ":-)".
-
------------------------------------------------------------------------------
OPTION SYNTAX *quickrun-syntax-option*
@@ -328,7 +264,7 @@ e.g.: >
@a
&{fileencoding}
$PATH
- {expr}
+ %{expr}
{expr} is evaluated using |eval()|.
If an error occurred, it is replaced by empty string.
If you want to avoid evaluation, you need to escape with \ .
@@ -379,9 +315,6 @@ It is useful when you need to do compile, clean up something.
SETTINGS *quickrun-settings*
*g:quickrun_config*
-NOTE: Currently this section explains about |quickrun| version 0.4.7 or
- older. |quickrun| version 0.5.0 setting is very different to 0.4.7.
-
You can define default values using |g:quickrun_config|.
"Default Value" is |Dictionary| whose key is |quickrun-options| names.
And |g:quickrun_config| is |Dictionary| whose key is {type},
@@ -424,6 +357,308 @@ In addition, if you set {type} with 3 or 4, {type} is overwrote and reload the
current (3 or 4) config. Note infinite loop.
+==============================================================================
+MODULE *quickrun-module*
+
+|quickrun| is structured modularly. There are the following kinds of modules.
+
+- runner (|quickrun-module-runner|)
+- outputter (|quickrun-module-outputter|)
+
+A module sometimes has its specific options. You may specify an option as a
+normal option or as a postfix of the module.
+
+Specifying an option as a normal option
+--------------------------
+A module reads options with the following prioitized order when you specified
+an option as a normal option.
+
+1. "{module-type}/{module-name}/{option-name}"
+2. "{module-type}/{option-name}"
+3. "{option-name}"
+
+For example when you'd like to give "append" option to "outputter/buffer"
+module, you can give it by
+>
+ let b:quickrun_config = {'outputter/buffer/append': 1}
+<
+or,
+>
+ :QuickRun -outputter/buffer/append 1
+<
+Furthermore the following way is also available, whereas if there is a more
+prioitized option then that'll be prioitized.
+>
+ :QuickRun -append 1
+<
+
+Specifying an option as a postfix of a module
+----------------------
+You may give an option when you give a module in command line option. Write an
+arbitrary symbol after the module name, and split option values with the
+symbol. Specify each options in name=value format.
+>
+ :QuickRun -outputter buffer:append=1:into=1
+<
+Some modules only have one single option or have specific order of options
+defined in |quickrun-module.config_order|. In this case, you don't have to
+give name.
+>
+ :QuickRun -outputter file:/path/to/file
+<
+If the value of option is list, it appends the option value.
+
+
+|quickrun-syntax-option| expands any options before they go to the module.
+
+------------------------------------------------------------------------------
+RUNNER *quickrun-module-runner*
+
+Runner is a module to run a program. The following runners are available by
+default. NOTE: Everything except for "system" can be unstable.
+
+- "system"
+ Runs by |system()|. This is the default.
+
+- "shell"
+ Runs by |:!|. This ignores given outputter.
+ Option ~
+ {shellcmd} Default: 'silent !"%s" & pause' for MS Windows
+ Otherwise '!%s'
+ The template of the Vim command to run. This replaces %s to the
+ command given in exec option.
+
+- "vimproc"
+ {Requirement: |vimproc|}
+ Runs by |vimproc| in background. This checks if the process completed with
+ using |CursorHold| |CursorHoldI| events. If the process completed within 50
+ millisecond, it shows the result immediately.
+ Option ~
+ {updatetime} Default: 0
+ Changes 'updatetime' to the value temporary. Stays same if this is 0.
+
+- "remote"
+ {Requirement: |+clientserver|}
+ Runs in background and fetches the result by |+clientserver| feature.
+ This requires |v:servername| to be set. If Vim doesn't, run it with
+ |--servername| option.
+
+ Note that Vim cannot control the process when it doesn't terminate due to
+ infinite loop or to wait for input since it runs in background.
+ Option ~
+ {vimproc} Default: 0
+ Runs by |vimproc| if it's available. You can cancel the process after
+ it ran.
+
+- "python"
+ {Requirement: |+python|}
+ Runs by |python| thread asynchronously.
+ WARNING: This is absolutely unstable.
+ WARNING: Don't use this on X11. Vim crashes.
+
+
+------------------------------------------------------------------------------
+OUTPUTTER *quickrun-module-outputter*
+
+Outputter is a module to output the result. The following outputters are
+available by default.
+
+- "buffer"
+ quickrun opens output buffer and displays to the output buffer. If output
+ buffer already exists, quickrun uses it. And for customize, quickrun sets
+ "quickrun" to 'filetype' of this buffer. This is the default.
+ Option ~
+ {append} Default: 0
+ Appends if it's 1.
+ {split}
+ Default: '{winwidth(0) * 2 < winheight(0) * 5 ? "" : "vertical"}'
+
+ Specifies a sub-command to open a buffer for the output. |quickrun|
+ inserts this before |:split| command when it opens a buffer.
+ {into} Default: 0
+ Moves cursor to the output buffer if this isn't 0.
+ {running_mark} Default: ':-)'
+ If this value is not an empty string, |quickrun| displays this string
+ to output buffer while it's running.
+
+- "message"
+ |messages| §ÀΩ–Œœ§∑§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {log} •«•’•©•Î•»: 0
+ 1 §ŒæÏπÁ°¢Ω–Œœ§Ú |message-history| §Àµ≠œø§∑§fi§π°£
+
+- "variable"
+  —øÙ§À¬–§∑§∆Ω–Œœ§∑§fi§π°£¥ƒ∂≠ —øÙ§‰•™•◊•∑•Á•Û§À¬–§∑§∆§‚Ω–Œœ≤ƒ«Ω§«§π°£
+ •™•◊•∑•Á•Û ~
+ {name} •«•’•©•Î•»: ''
+ Ω–Œœ¿Ë§Œ —øÙÃ槫§π°£∂ı§ŒæÏπÁ§œ•®•È°º§À§ §Í§fi§π°£
+ {append} •«•’•©•Î•»: 0
+ 1 §ŒæÏπÁ§œƒ…µ≠§Ú𑧧§fi§π°£
+
+- "file"
+ •’•°•§•Î§À¬–§∑§∆Ω–Œœ§∑§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {name} •«•’•©•Î•»: ''
+ Ω–Œœ¿Ë§Œ•’•°•§•ÎÃ槫§π°£∂ı§ŒæÏπÁ§œ•®•È°º§À§ §Í§fi§π°£
+ {append} •«•’•©•Î•»: 0
+ 1 §ŒæÏπÁ§œƒ…µ≠§Ú𑧧§fi§π°£
+
+- "quickfix"
+ |quickfix| §ÿΩ–Œœ§∑§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {errorformat} •«•’•©•Î•»: "&errorformat"
+ Ω–Œœ§Ú≤Úº·§π§Î§ø§·§Œ 'errorformat' •™•◊•∑•Á•Û§Œ√Õ§«§π°£
+
+- "browser"
+ {|open-browser| §¨…¨Õ◊}
+ |open-browser| §Úª»§√§∆°¢∑Î≤çڕ÷•È•¶•∂§«≥´§≠§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {name} •«•’•©•Î•»: tempname() . '.html'
+ §≥§Œ outputter §œ§fi§∫∑Î≤çڕ’•°•§•Î§ÀΩÒ§≠Ω–§∑°¢§Ω§Œ•’•°•§•Î§Ú•÷•È•¶•∂
+ §«≥´§≠§fi§π°£§Ω§Œ∫›§ŒΩ–Œœ¿Ë§Œ•’•°•§•ÎÃ槫§π°£
+ •«•’•©•Î•»√Õ§Œ |tempname()| §œΩÈ≤Û•Ì°º•…ª˛§À 1 ≈Ÿ§¿§±∏∆§”Ω–§µ§Ï°¢¡¥¬Œ
+ §«∏«ƒÍ§À§ §Í§fi§π°£
+ {append} •«•’•©•Î•»: 0
+ 1 §ŒæÏπÁ§œ•’•°•§•Î§À¬–§∑§∆ƒ…µ≠§Ú𑧧§fi§π°£
+
+- "buffered"
+ Ω–Œœ§Ú•–•√•’•°•Í•Û•∞§∑§∆°¢∫«∏§À∞Ï≈Ÿ§ÀΩ–Œœ§∑§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {target} •«•’•©•Î•»: ''
+ º¬∫›§ŒΩ–Œœ§Àª»§¶ outputter §«§π°£
+
+- "multi"
+  £øÙ§Œ outputter §À¬–§∑§∆∆±ª˛§ÀΩ–Œœ§Ú𑧧§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {targets} •«•’•©•Î•»: []
+ º¬∫›§ŒΩ–Œœ§Àª»§¶ outputter §Œ•Í•π•»§«§π°£
+
+- "error"
+ º¬π‘§¨¿µæÔΩ™Œª§∑§øæÏπÁ§»§Ω§¶§«§ §§æÏπÁ§« outputter §Ú —§®§fi§π°£Ω™Œª•≥°º•…§¨
+ 0 §ŒæÏπÁ§Ú¿µæÔΩ™Œª§»§∑§fi§π°£§ø§¿§∑°¢runner §À§Ë§√§∆§œæÔ§À¿µæÔΩ™Œª§»§ §√§∆§∑
+ §fi§¶§≥§»§¨§¢§Í§fi§π°£
+ Ω™Œª§Ú¬‘§ƒ§ø§·°¢Ω–Œœ§œ•–•√•’•°•Í•Û•∞§µ§Ï§fi§π°£
+ •™•◊•∑•Á•Û ~
+ {success} •«•’•©•Î•»: "null"
+ º¬π‘§Œ¿Æ∏˘ª˛§Àª»§¶ outputter §«§π°£
+ {error} •«•’•©•Î•»: "null"
+ º¬π‘§Œº∫«‘ª˛§Àª»§¶ outputter §«§π°£
+
+- "null"
+ Ω–Œœ§Ú𑧧§fi§ª§Û°£
+
+
+
+==============================================================================
+•‚•∏•Â°º•Î§Œ∫Ó¿Æ *quickrun-create-module*
+
+•‚•∏•Â°º•Î§œ∆√ƒÍ§Œ¬∞¿≠§Úª˝§√§øº≠ΩÒ(|Dictionary|)§«§π°£º≠ΩÒ§Ú∫ӿƧ∑§ø∏°¢≈–œø§Ú
+𑧶§≥§»§«ª»§®§Î§Ë§¶§À§ §Í§fi§π°£
+
+------------------------------------------------------------------------------
+•‚•∏•Â°º•Î§Œ≈–œø *quickrun-register-module*
+
+•‚•∏•Â°º•Î§œ°¢|quickrun#register_module()| §‰§Ω§Œæ Œ¨∑¡§«§¢§Î
+|quickrun#register_runner()|°¢|quickrun#register_outputter()| §Úª»§√§∆≈–œø§π§Î
+§≥§»§« ª»§®§Î§Ë§¶§À§ §Í§fi§π°£
+§fi§ø°¢'runtimepath' ∆‚§À autoload/quickrun/{module-kind}/{module-name}.vim §Ú
+∫ӿƧ∑°¢autoload#quickrun#{module-kind}#{module-name}#new() ¥ÿøÙ§Ú∫Ó§√§∆§™§Ø
+§»°¢§Ω§ŒÃ·§Í√Õ§¨ quickrun §ŒΩÈ≤Û•Ì°º•…ª˛§Àº´∆∞≈™§À≈–œø§µ§Ï§fi§π°£
+
+------------------------------------------------------------------------------
+•ª•√•∑•Á•Û *quickrun-session*
+
+quickrun §«§œ 1 ≤Û§Œº¬π‘§Ú•ª•√•∑•Á•Û({session})§»§∑§∆¥…Õ˝§∑§∆§™§Í°¢•‚•∏•Â°º•Î
+§Œ≥∆¥ÿøÙ§À∞˙øÙ§»§∑§∆≈œ§µ§Ï§fi§π°£
+
+session.make_module({kind}, {line}) *quickrun-session.make_module()*
+ •ª•√•∑•Á•Û√ʧ«ª»§®§Î§Ë§¶§À•‚•∏•Â°º•Î§Ú¿∏¿Æ§∑§fi§π°£
+
+session.output({data}) *quickrun-session.output()*
+ runner §¨Ω–Œœ§Ú𑧶∫›§À∏∆§”Ω–§∑§fi§π°£{data} §œ§Ω§Œæϧ« outputter §ÿ≈œ
+ §µ§Ï§fi§π°£º¬π‘√ʧœ≤ø≈Ÿ∏∆§”Ω–§∑§∆§‚ɬͧ¢§Í§fi§ª§Û°£
+
+session.continue() *quickrun-session.continue()*
+ runner §¨§Ω§Œæϧ«º¬π‘§Ú¥∞Œª§«§≠§ §§ª˛§À∏∆§”Ω–§∑§fi§π°£{key} §Ú ÷§∑§fi
+ §π°£|quickrun#session()| §À {key} §Ú≈œ§π§≥§»§«°¢º¬π‘§Ú∑—¬≥§∑§fi§π°£
+
+session.finish([{exit-code}]) *quickrun-session.finish()*
+ runner §¨º¬π‘§¨¡¥§∆¥∞Œª§∑§ø∫›§À∏∆§”Ω–§∑§fi§π°£{exit-code} §¨æ Œ¨§µ§Ï§ø
+ æÏπÁ§œ 0 §À§ §Í§fi§π°£
+
+session.exit_code *quickrun-session.exit_code*
+ º¬π‘§¨¥∞Œª§∑§ø∏§À§Œ§flª≤滧«§≠§fi§π°£|quickrun-session.finish()| §«≈œ§µ
+ §Ï§ø√Õ§«§π°£
+
+session.sweep() *quickrun-session.sweep()*
+ •ª•√•∑•Á•Û§Œ∏ªœÀˆ§Ú𑧧§fi§π°£•ª•√•∑•Á•Û§À¬–§∑§∆∞ ≤º§Œ¬∞¿≠§¨¿flƒÍ§µ§Ï§∆
+ §§§øæÏπÁ°¢§Ω§Ï§À±˛§∏§øΩËÕ˝§¨π‘§Ô§Ï§fi§π°£
+ - "_temp_" §«ªœ§fi§Î¬∞¿≠§¨§¢§√§øæÏπÁ°¢§Ω§Œ√Õ§Ú•’•°•§•ÎÃ槻§∑§∆•’•°•§•Î
+ §Ú∫ÔΩ¸§∑§fi§π°£
+ - "_option_{option-name}" §»§§§¶¬∞¿≠§¨§¢§√§øæÏπÁ°¢•™•◊•∑•Á•Û§Œ√Õ§Ú…¸∏µ
+ §∑§fi§π°£
+ - "_autocmd_" §«ªœ§fi§Î¬∞¿≠§¨§¢§√§øæÏπÁ°¢"plugin-quickrun-{value}" §»§§
+ §¶Ãæ¡∞§Œ•∞•Î°º•◊§À¬∞§π§Î autocmd §Ú¡¥§∆∫ÔΩ¸§∑§fi§π°£
+ - "_vimproc" §»§§§¶¬∞¿≠§¨§¢§√§øæÏπÁ°¢§Ω§Œ |vimproc| §Ú∂Ø¿©Ω™Œª§∑§fi§π°£
+ §fi§ø°¢|quickrun-runner.sweep()| §Ú∏∆§”Ω–§∑§fi§π°£
+ §≥§Ï§È§œ ÿÕ¯§«§π§¨°¢∫£§Œ§»§≥§Ì £øÙ§Œ•‚•∏•Â°º•Î§´§Èª»§Ô§Ï§ø∫›§ŒÃæ¡∞§Œæ◊
+ ∆Õ§¨πÕŒ∏§µ§Ï§∆§§§fi§ª§Û°£§≥§Ï§œæ≠ÕË≤˛¡±§µ§Ï§Î≤ƒ«Ω¿≠§¨§¢§Í§fi§π°£
+
+------------------------------------------------------------------------------
+∂¶ƒÃ§Œ¬∞¿≠ *quickrun-module-attributes*
+
+•‚•∏•Â°º•Î§Œ¬∞¿≠§Œ¬ø§Ø§œ•«•’•©•Î•»√Õ§¨§¢§Í°¢…¨ø‹§»Ã¿µ≠§µ§Ï§∆§§§Î¬∞¿≠∞ ≥∞§œÃ¿º®
+≈™§À¿flƒÍ§π§Î…¨Õ◊§œ§¢§Í§fi§ª§Û°£§ø§¿§∑°¢…¨Õ◊§À±˛§∏§∆•«•’•©•Î•»√Õ§ÚæÂΩÒ§≠§π§Î§≥§»
+§¨§«§≠§fi§π°£
+•‚•∏•Â°º•Î§¨º¬∫›§Àª»§Ô§Ï§Î∫›§œ°¢≈–œø§∑§ø•‚•∏•Â°º•Î§Œ•≥•‘°º§¨ª»§Ô§Ï§fi§π°£•ª•√
+•∑•Á•Û√ʧÀ•‚•∏•Â°º•ÎÀ˧À√Õ§Ú ›ª˝§∑§ø§§æÏπÁ§œ°¢¥˚¬∏§Œ¬∞¿≠§»§Œæ◊∆Õ§Ú»Ú§±§Î§ø§·§À
+"_" §«ªœ§fi§Î¬∞¿≠§Úª»Õ—§∑§∆§Ø§¿§µ§§°£
+∞ ≤º§œ¡¥•‚•∏•Â°º•Î§«∂¶ƒÃ§Œ¬∞¿≠§«§π°£
+
+module.config *quickrun-module.config*
+ §≥§Ï§œº≠ΩÒ§«°¢§≥§Œ•‚•∏•Â°º•Î§¨ºË§Î config §Œ•«•’•©•Î•»√Õ§«§π°£§≥§≥§«ƒÍ
+ µ¡§µ§Ï§∆§§§Î§‚§Œ§¿§±§¨°¢•‚•∏•Â°º•Î§«Õ≠∏˙§ •≥•Û•’•£•∞§»§ §Í§fi§π°£
+ •‚•∏•Â°º•Î§Úº¬∫›§Àª»§¶∫›§À§œ°¢•ª•√•∑•Á•Û§À§Ë§√§∆¿flƒÍ§¨æÂΩÒ§≠§µ§Ï§fi§π°£
+
+module.config_order *quickrun-module.config_order*
+ §≥§Ï§œ•Í•π•»§«°¢config §Œ∞˙øÙ§ŒΩÁΩ¯§«§π°£|quickrun-module.config| §«ªÿ
+ ƒÍ§µ§Ï§∆§§§ÎÃæ¡∞§Ú«§∞’§ŒΩÁΩ¯§« ¬§Ÿ§fi§π°£
+
+module.available() *quickrun-module.available()*
+ |quickrun-module.validate()| §Úª»§√§∆§≥§Œ•‚•∏•Â°º•Î§¨Õ¯Õ—≤ƒ«Ω§´§Úƒ¥§Ÿ
+ §fi§π°£Õ¯Õ—≤ƒ«Ω§ §È 1°¢§Ω§¶§«§ §±§Ï§– 0 §Ú ÷§∑§fi§π°£
+
+module.validate() *quickrun-module.validate()*
+ •‚•∏•Â°º•Î§¨Õ¯Õ—≤ƒ«Ω§ æı∂∑§À§¢§Î§´§Ú∏°æ⁄§∑§fi§π°£Õ¯Õ—§«§≠§ §§æÏπÁ§œ°¢§Ω
+ §ŒÕ˝Õ≥§»§ §Î ∏ª˙ŒÛ§Ú |:throw| §∑§fi§π°£
+
+module.init({session}) *quickrun-module.init()*
+ •‚•∏•Â°º•Î§ŒΩÈ¥¸≤Ωª˛§À∏∆§”Ω–§µ§Ï§fi§π°£
+
+------------------------------------------------------------------------------
+RUNNER ATTRIBUTES *quickrun-runner-attributes*
+
+runner.run({commands}, {input}, {session}) *quickrun-runner.run()*
+ …¨ø‹§«§π°£º¬π‘ª˛§À∏∆§”Ω–§µ§Ï§fi§π°£{commands} §«≈œ§µ§Ï§ø•≥•fi•Û•…§Œ•Í•π
+ •»§Úº¬π‘ §∑°¢{exit-code} §Ú ÷§∑§fi§π°£{input} §œ…∏Ω‡∆˛Œœ•«°º•ø§«§π°£
+ §Ω§Œæϧ«º¬π‘§Ú¥∞Œª§«§≠§ §§ª˛§œ°¢|quickrun-session.continue()| §Úª»§§§fi
+ §π°£§Ω§ŒæÏπÁ°¢|quickrun-session.finish()| §Ú∏∆§”Ω–§π…¨Õ◊§¨§¢§Í§fi§π°£
+
+runner.sweep() *quickrun-runner.sweep()*
+ º¬π‘§Œ¥∞Œª°¢§‚§∑§Ø§œ∂Ø¿©Ω™Œªª˛§À∏∆§”Ω–§µ§Ï§fi§π°£º¬π‘√ʧŒ•«°º•ø§Œ∏ªœÀˆ
+ §Ú𑧧§fi§π°£
+
+------------------------------------------------------------------------------
+OUTPUTTER ATTRIBUTES *quickrun-outputter-attributes*
+
+outputter.output({data}, {session}) *quickrun-outputter.output()*
+ Required. Outputs the data.
+
+outputter.finish({session}) *quickrun-outputter.finish()*
+ Called in termination for finishing it. You can refer
+ |quickrun-session.exit_code|.
+
+
==============================================================================
CHANGELOG *quickrun-changelog*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment