Skip to content

Commit a3ea7f3

Browse files
jimmycuadrajimmycuadra
committed
Update documentation.
1 parent 9e4b45d commit a3ea7f3

File tree

7 files changed

+81
-77
lines changed

7 files changed

+81
-77
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ The value is copied to your clipboard.
4545

4646
Bang's data is serialized to JSON and peristed to a file at `~/.bang`. If you want to share your Bang data across multiple machines, you can move the file to [Dropbox](https://www.dropbox.com/) or some other type of network disk, and then symlink it to `~/.bang` on your local machine.
4747

48+
## Using Bang programmatically
49+
50+
Bang can also be used from a Node program directly. Simply `require("bang")` to import the core Bang class with access to all the CRUD methods.
51+
4852
## Tests
4953

5054
Bang includes a comprehensive test suite using [Jasmine](http://pivotal.github.com/jasmine/). To run it:

‎docs/cli.html‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!DOCTYPE html> <html> <head> <title>cli.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="../index.html"> bang.coffee </a> <a class="source" href="cli.html"> cli.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> cli.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="p">{</span><span class="nx">Command</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span> <span class="s2">&quot;commander&quot;</span>
2+
<span class="nv">Bang = </span><span class="nx">require</span> <span class="s2">&quot;./bang&quot;</span>
3+
<span class="p">{</span><span class="nx">exec</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span> <span class="s2">&quot;child_process&quot;</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <p>Command line interface to <a href="https://github.com/jimmycuadra/bang">Bang</a>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">module.exports = </span><span class="k">class</span> <span class="nx">CLI</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Initializes a Bang instance and a Commander instance to process
4+
arguments passed from the shell. The optional second argument
5+
is an instance of Bang with methods stubbed out for testing
6+
purposes.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">constructor: </span><span class="nf">(args, mockBang) -&gt;</span>
7+
<span class="vi">@bang = </span><span class="nx">mockBang</span> <span class="o">or</span> <span class="k">new</span> <span class="nx">Bang</span>
8+
<span class="vi">@program = </span><span class="k">new</span> <span class="nx">Command</span>
9+
10+
<span class="nx">@program</span><span class="p">.</span><span class="nx">version</span><span class="p">(</span><span class="s2">&quot;0.2.0&quot;</span><span class="p">)</span>
11+
<span class="p">.</span><span class="nx">usage</span><span class="p">(</span><span class="s2">&quot;[options] [key] [value]&quot;</span><span class="p">)</span>
12+
<span class="p">.</span><span class="nx">option</span><span class="p">(</span><span class="s2">&quot;-d, --delete&quot;</span><span class="p">,</span> <span class="s2">&quot;delete the specified key&quot;</span><span class="p">)</span>
13+
<span class="p">.</span><span class="nx">option</span><span class="p">(</span><span class="s2">&quot;-h, --help&quot;</span><span class="p">,</span> <span class="s2">&quot;get help&quot;</span><span class="p">)</span>
14+
<span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">args</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>Delegates to Bang methods determined by
15+
arguments passed from the command line.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">start: </span><span class="o">-&gt;</span>
16+
<span class="p">[</span><span class="nx">key</span><span class="p">,</span> <span class="nx">value</span><span class="p">]</span> <span class="o">=</span> <span class="nx">@program</span><span class="p">.</span><span class="nx">args</span>
17+
18+
<span class="k">if</span> <span class="nx">@program</span><span class="p">.</span><span class="nx">help</span>
19+
<span class="nx">@log</span> <span class="nx">@program</span><span class="p">.</span><span class="nx">helpInformation</span><span class="p">()</span>
20+
<span class="k">else</span> <span class="k">if</span> <span class="nx">key</span> <span class="o">and</span> <span class="nx">@program</span><span class="p">.</span><span class="k">delete</span>
21+
<span class="nx">@bang</span><span class="p">.</span><span class="k">delete</span> <span class="nx">key</span>
22+
<span class="k">else</span> <span class="k">if</span> <span class="nx">key</span> <span class="o">and</span> <span class="nx">value</span>
23+
<span class="nx">@bang</span><span class="p">.</span><span class="nx">set</span> <span class="nx">key</span><span class="p">,</span> <span class="nx">value</span>
24+
<span class="k">else</span> <span class="k">if</span> <span class="nx">key</span>
25+
<span class="nv">value = </span><span class="nx">@bang</span><span class="p">.</span><span class="nx">get</span> <span class="nx">key</span>
26+
<span class="k">if</span> <span class="nx">value</span>
27+
<span class="nx">@log</span> <span class="nx">value</span>
28+
<span class="nx">@copy</span> <span class="nx">value</span>
29+
<span class="k">else</span> <span class="k">if</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">@bang</span><span class="p">.</span><span class="nx">data</span><span class="p">).</span><span class="nx">length</span> <span class="o">is</span> <span class="mi">0</span>
30+
<span class="nx">@log</span> <span class="nx">@program</span><span class="p">.</span><span class="nx">helpInformation</span><span class="p">()</span>
31+
<span class="k">else</span>
32+
<span class="nx">@log</span> <span class="nx">@bang</span><span class="p">.</span><span class="nx">list</span><span class="p">()</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>Wraps <code>console.log</code> for testing purposes.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">log: </span><span class="nf">(args...) -&gt;</span>
33+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="nx">args</span><span class="p">...</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>Copies a value to the clipboard.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">copy: </span><span class="nf">(value) -&gt;</span>
34+
<span class="nv">copyCommand = </span><span class="k">switch</span> <span class="nx">process</span><span class="p">.</span><span class="nx">platform</span>
35+
<span class="k">when</span> <span class="s2">&quot;darwin&quot;</span> <span class="k">then</span> <span class="s2">&quot;pbcopy&quot;</span>
36+
<span class="k">when</span> <span class="s2">&quot;win32&quot;</span> <span class="k">then</span> <span class="s2">&quot;clip&quot;</span>
37+
<span class="k">else</span> <span class="s2">&quot;xclip -selection clipboard&quot;</span>
38+
39+
<span class="k">if</span> <span class="nx">process</span><span class="p">.</span><span class="nx">platform</span> <span class="o">is</span> <span class="s2">&quot;win32&quot;</span>
40+
<span class="nx">exec</span> <span class="s2">&quot;echo #{value.replace(/\&#39;/g, &quot;</span><span class="err">\\</span><span class="s1">&#39;&quot;)} | #{copyCommand}&quot;</span>
41+
<span class="s1"> else</span>
42+
<span class="s1"> exec &quot;printf &#39;</span><span class="c1">#{value.replace(/\&#39;/g, &quot;\\&#39;&quot;)}&#39; | #{copyCommand}&quot;</span>
43+
44+
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

0 commit comments

Comments
 (0)