Skip to content

Commit

Permalink
fix(CommandLineParser): When using as a library, enqueuer handles an …
Browse files Browse the repository at this point in the history
…empty command line argument.
  • Loading branch information
virgs committed Mar 28, 2019
1 parent 9eaadbd commit ea017eb
Show file tree
Hide file tree
Showing 8 changed files with 1,273 additions and 1,259 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ And then, run this other one:
I told you it was simple.
Now go nuts!
It's all yours. Have fun.
If you want more examples about `http`, consider looking at [this test](https://github.com/enqueuer-land/enqueuer/blob/master/examples/http-more-examples.yml).
Check [this out](https://github.com/enqueuer-land/enqueuer/blob/master/examples/), you'll find countless examples.
Certainly one is what you need.

Expand Down Expand Up @@ -683,8 +684,8 @@ Consider looking at the example of [configuration file](https://github.com/enque


#### plugin use
In order to enqueuer get awareness that you want to you a plugin, you have to tell it, right?
You can tell enqueuer to use a plugin in three manners. Using it as a command line argument, through the configuration file or letting enqueuer finding it in it's home directory folder.
In order to enqueuer get awareness that you want to use a plugin, you have to tell it, right?
You can tell enqueuer to use a plugin in three manners: using it as a command line argument, through the configuration file or letting enqueuer finding it in a default location.

##### command line
Tell enqueuer to use your plugin through command line this way `$ nqr -l <plugin-folder> -l <another-plugin-folder>`.
Expand All @@ -700,7 +701,8 @@ Tell enqueuer to use your plugin through configuration file this way:
Where plugin-folder and another-plugin-folder are the directories where the plugins are installed in.

##### implicitly
When enqueuer runs, it looks for modules in `.nqr` folder in your home directory. Every enqueuer compatible module get implicitly loaded.
When enqueuer runs, it looks for modules in `.nqr` folder in your home, a.k.a. ~/ folder, in linux distributions, directory.
Every enqueuer compatible module get implicitly loaded.
In order to be enqueuer compatible, a module has to have an `entryPoint` exported function in its main file and, in its package.json file, it has to have either 'enqueuer' or 'nqr' as keywords.

----
Expand Down
8 changes: 5 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ <h4 id="install_it" style="padding-left: 8px">1.1 install it</h4>
<p>I told you it was simple.
Now go nuts!
It's all yours. Have fun.
If you want more examples about <code class="yaml">http</code>, consider looking at <a href="https://github.com/enqueuer-land/enqueuer/blob/master/examples/http-more-examples.yml">this test</a>.
Check <a href="https://github.com/enqueuer-land/enqueuer/blob/master/examples/">this out</a>, you'll find countless examples.
Certainly one is what you need. </p>

Expand Down Expand Up @@ -1004,8 +1005,8 @@ <h5 id="report_formatter" style="padding-left: 16px">8.1.4 report formatter</h5>

<h4 id="plugin_use" style="padding-left: 8px">8.2 plugin use</h4>

<p>In order to enqueuer get awareness that you want to you a plugin, you have to tell it, right?
You can tell enqueuer to use a plugin in three manners. Using it as a command line argument, through the configuration file or letting enqueuer finding it in it's home directory folder.</p>
<p>In order to enqueuer get awareness that you want to use a plugin, you have to tell it, right?
You can tell enqueuer to use a plugin in three manners: using it as a command line argument, through the configuration file or letting enqueuer finding it in a default location.</p>

<h5 id="command_line" style="padding-left: 16px">8.2.1 command line</h5>

Expand All @@ -1025,7 +1026,8 @@ <h5 id="configuration_file" style="padding-left: 16px">8.2.2 configuration file<

<h5 id="implicitly" style="padding-left: 16px">8.2.3 implicitly</h5>

<p>When enqueuer runs, it looks for modules in <code class="yaml">.nqr</code> folder in your home directory. Every enqueuer compatible module get implicitly loaded.
<p>When enqueuer runs, it looks for modules in <code class="yaml">.nqr</code> folder in your home, a.k.a. ~/ folder, in linux distributions, directory.
Every enqueuer compatible module get implicitly loaded.
In order to be enqueuer compatible, a module has to have an <code class="yaml">entryPoint</code> exported function in its main file and, in its package.json file, it has to have either 'enqueuer' or 'nqr' as keywords.</p>

<hr />
Expand Down
Loading

0 comments on commit ea017eb

Please sign in to comment.