sublime-node-snippets
=====================

The majority of snippets for [node *v8.x*](https://nodejs.org/dist/latest-v8.x/docs/api/). There are **1083** total right now.

## Installing

#### Package Control

Just look for `Node Completions` on [Package Control](https://sublime.wbond.net/packages/Node%20Completions).

#### Manual

* Open the Commands Palette (command+shift+p)
* Package Control: Add Repository
* Past in this repos URL
* Press Enter
* Open the palette again
* press enter on "sublime-node-snippets"
* watch it install

## Using

Pressing `.` (period) will end the snippet lookup.

You will have better results if you pretend the period isn't needed. So if you are looking for `fs.readdir`, you would type `fsread` and you would see the results coming up.

## Snippet Categories

* Assertion Testing
* Buffer
* Child Processes
* Cluster
* Console
* Crypto
* DNS
* Domain
* Errors
* Events
* File System
* Globals
* HTTP
* HTTP/2
* HTTPS
* Inspector
* Modules
* Net
* OS
* Path
* Performance Hooks
* Process
* Punycode
* Query Strings
* Readline
* REPL
* Stream
* String Decoder
* Timers
* TLS/SSL
* TTY
* UDP/Datagram
* URL
* Utilities
* V8
* VM
* ZLIB

## Building

I went to each page of the node docs, and copied the functions. Then I wrote a converter to take each function and convert it to a snippet.

For Example, this line:

```
setTimeout(fun, delay)
```

Is going to get converted to:

```
setTimeout(${1:fun}, ${2:delay})${0}
```

When the word callback appears, it will convert it to the standard
`fun` snippet.

```javascript
fs.readdir(path, callback)
```

will become

```javascript
fs.readdir(${1:path}, function(${2:args}){
  ${3:// body}
})${0}
```

## sources.txt

This file is cool. It is just a line-by-line output of the node docs functions. This is the file that is raked over to generate the snippets.

## Running The Build

Just run `node build.js` and it will rake the sources.txt file and then write the new snippet in the snippets folder.

Everything before the first `(` will be used as the filename.

## Adding New Snippets

Here is how I quickly got all these snippets. I will use [Express](http://expressjs.com/3x/api.html) as an example since it isn't in here.

First I went to the docs for the framework, and I looked to see what the code examples were wrapped in.

For the [express](http://expressjs.com/3x/api.html) docs site, the codes are show in `section h3` tags. So to quickly get the list, I ran the following code:

```javascript
Array.prototype.slice.call(document.querySelectorAll("section h3"), 0).map(function(item){
  return item.textContent.trim();
}).join("\n");
```

Then copied the output and pasted it in the sources.txt file. Done!

**The word `callback` will automagically be converted into a function.**

## Contributing

Just add (or edit) a line in the source file. Then run `node build.js` to generate the new snippets.

## License

**The MIT License**

Copyright (c) 2014 [James Doyle](http://twitter.com/james2doyle) james2doyle@gmail.com

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.