rondomoon/peer-calls
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Jerko Steiner 2017-06-18 09:40:40 -04:00
parent 57b3d3ca6a
commit b93e062f91
5 changed files with 27 additions and 581 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -20,9 +20,9 @@ pull request will be rejected.
1. Fork the repo
2. Install dependencies: `npm install`
3. Make sure the tests pass: `npm test`
4. Make your change on a new feature branch, with new passing tests. Follow
the [style guide][style].
3. Make sure the tests pass: `npm run ci`
4. Make your change on a new feature branch, with new passing tests. We use
ESLint to lint the code.
5. Push to your fork.
6. Make sure to rebase to master and squash commits to a single commit.
7. Write a [good commit message][commit].
@ -30,7 +30,6 @@ pull request will be rejected.
- Remember that you can also [close][close] the issue with this message.
8. Submit a pull request.
[style]: STYLE.md
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[reference]: https://help.github.com/articles/autolinked-references-and-urls/#issues-and-pull-requests
[close]: https://help.github.com/articles/closing-issues-via-commit-messages/
@ -41,5 +40,7 @@ merge the contribution.
## License
As the project uses the MIT license, you agree that any code you submit to the
As the project uses the [MIT license][license], you agree that any code you submit to the
project will also be licensed under the same license.
[license]: LICENSE

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2017 Jerko Steiner
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.

2
README.md
View File

@ -63,4 +63,4 @@ See [Contributing](CONTRIBUTING.md) section.
# License
MIT
[MIT](LICENSE)

574
STYLE.md
View File

@ -1,574 +0,0 @@
# Style Guide
This is a guide for writing consistent and aesthetically pleasing
node.js/javascriptcode. It is inspired by what is popular within the community,
and flavored with some personal opinions.
There is a .eslintrc which enforces these rules as closely as possible. You can
use [eslint](http://eslint.org/docs/user-guide/integrations) to lint and check
your files.
## Table of contents
### Formatting
* [2 Spaces for indentation](#2-spaces-for-indentation)
* [Newlines](#newlines)
* [No trailing whitespace](#no-trailing-whitespace)
* [Use Semicolons](#use-semicolons)
* [80 characters per line](#80-characters-per-line)
* [Use single quotes](#use-single-quotes)
* [Opening braces go on the same line](#opening-braces-go-on-the-same-line)
* [Declare one variable per var statement](#declare-one-variable-per-var-statement)
### Naming Conventions
* [Use lowerCamelCase for variables, properties and function names](#use-lowercamelcase-for-variables-properties-and-function-names)
* [Use UpperCamelCase for class names](#use-uppercamelcase-for-class-names)
* [Use UPPERCASE for Constants](#use-uppercase-for-constants)
* [Use let instead of var](#use-let-instead-of-var)
### Variables
* [Object / Array creation](#object--array-creation)
### Conditionals
* [Use the === operator](#use-the--operator)
* [Use descriptive conditions](#use-descriptive-conditions)
### Functions
* [Write small functions](#write-small-functions)
* [Return early from functions](#return-early-from-functions)
* [Name your closures](#name-your-closures)
* [No nested closures](#no-nested-closures)
* [Method chaining](#method-chaining)
### Comments
* [Use slashes for comments](#use-slashes-for-comments)
### Miscellaneous
* [Object.freeze, Object.preventExtensions, Object.seal, with, eval](#objectfreeze-objectpreventextensions-objectseal-with-eval)
* [Requires At Top](#requires-at-top)
* [Getters and setters](#getters-and-setters)
* [Do not extend built-in prototypes](#do-not-extend-built-in-prototypes)
## Formatting
### 2 Spaces for indentation
Use 2 spaces for indenting your code and swear an oath to never mix tabs and
spaces - a special kind of hell is awaiting you otherwise.
### Newlines
Use UNIX-style newlines (`\n`), and a newline character as the last character
of a file. Windows-style newlines (`\r\n`) are forbidden inside any repository.
### No trailing whitespace
Just like you brush your teeth after every meal, you clean up any trailing
whitespace in your JS files before committing. Otherwise the rotten smell of
careless neglect will eventually drive away contributors and/or co-workers.
### Use Semicolons
According to [scientific research][hnsemicolons], the usage of semicolons is
a core value of our community. Consider the points of [the opposition][], but
be a traditionalist when it comes to abusing error correction mechanisms for
cheap syntactic pleasures.
[the opposition]: http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding
[hnsemicolons]: http://news.ycombinator.com/item?id=1547647
### 80 characters per line
Limit your lines to 80 characters. Yes, screens have gotten much bigger over the
last few years, but your brain has not. Use the additional room for split screen,
your editor supports that, right?
### Use single quotes
Use single quotes, unless you are writing JSON.
*Right:*
```js
var foo = 'bar';
```
*Wrong:*
```js
var foo = "bar";
```
### Opening braces go on the same line
Your opening braces go on the same line as the statement.
*Right:*
```js
if (true) {
console.log('winning');
}
```
*Wrong:*
```js
if (true)
{
console.log('losing');
}
```
Also, notice the use of whitespace before and after the condition statement.
### Declare one variable per var statement
Declare one variable per var statement, it makes it easier to re-order the
lines. However, ignore [Crockford][crockfordconvention] when it comes to
declaring variables deeper inside a function, just put the declarations wherever
they make sense.
*Right:*
```js
var keys = ['foo', 'bar'];
var values = [23, 42];
var object = {};
while (keys.length) {
var key = keys.pop();
object[key] = values.pop();
}
```
*Wrong:*
```js
var keys = ['foo', 'bar'],
values = [23, 42],
object = {},
key;
while (keys.length) {
key = keys.pop();
object[key] = values.pop();
}
```
*Also wrong:*
```js
var keys = ['foo', 'bar'];
var values = [23, 42];
```
[crockfordconvention]: http://javascript.crockford.com/code.html
### Naming Conventions
### Use lowerCamelCase for variables, properties and function names
Variables, properties and function names should use `lowerCamelCase`. They
should also be descriptive. Single character variables and uncommon
abbreviations should generally be avoided.
*Right:*
```js
var adminUser = db.query('SELECT * FROM users ...');
```
*Wrong:*
```js
var admin_user = db.query('SELECT * FROM users ...');
```
### Use UpperCamelCase for class names
Class names should be capitalized using `UpperCamelCase`.
*Right:*
```js
function BankAccount() {
}
```
*Wrong:*
```js
function bank_Account() {
}
```
## Use UPPERCASE for Constants
Constant `Strings` and `Numbers` should be declared with `const`, using
uppercase letters.
Required modules and other static objects should also be defined using `const`
keyword, however they do not need to be uppercase to make the code more
readable.
*Right:*
```js
const myModule = require('my-module');
const SECOND = 1 * 1000;
function File() {
}
File.FULL_PERMISSIONS = 0777;
```
*Wrong:*
```js
var myModule = require('my-module');
var SECOND = 1 * 1000;
function File() {
}
File.fullPermissions = 0777;
```
## Use let instead of var
Use `let` instead of `var` where possible.
## Variables
### Object / Array creation
Use trailing commas and put *short* declarations on a single line. Only quote
keys when your interpreter complains:
*Right:*
```js
var a = ['hello', 'world'];
var b = {
good: 'code',
'is generally': 'pretty',
};
```
*Wrong:*
```js
var a = [
'hello', 'world'
];
var b = {"good": 'code'
, is generally: 'pretty'
};
```
## Conditionals
### Use the === operator
Programming is not about remembering [stupid rules][comparisonoperators]. Use
the triple equality operator as it will work just as expected.
*Right:*
```js
var a = 0;
if (a !== '') {
console.log('winning');
}
```
*Wrong:*
```js
var a = 0;
if (a == '') {
console.log('losing');
}
```
[comparisonoperators]: https://developer.mozilla.org/en/JavaScript/Reference/Operators/Comparison_Operators
### Use descriptive conditions
Any non-trivial conditions should be assigned to a descriptively named variable or function:
*Right:*
```js
var isValidPassword = password.length >= 4 && /^(?=.*\d).{4,}$/.test(password);
if (isValidPassword) {
console.log('winning');
}
```
*Wrong:*
```js
if (password.length >= 4 && /^(?=.*\d).{4,}$/.test(password)) {
console.log('losing');
}
```
## Functions
### Write small functions
Keep your functions short. A good function fits on a slide that the people in
the last row of a big room can comfortably read. So don't count on them having
perfect vision and limit yourself to ~15 lines of code per function.
### Return early from functions
To avoid deep nesting of if-statements, always return a function's value as early
as possible.
*Right:*
```js
function isPercentage(val) {
if (val < 0) {
return false;
}
if (val > 100) {
return false;
}
return true;
}
```
*Wrong:*
```js
function isPercentage(val) {
if (val >= 0) {
if (val < 100) {
return true;
} else {
return false;
}
} else {
return false;
}
}
```
Or for this particular example it may also be fine to shorten things even
further:
```js
function isPercentage(val) {
var isInRange = (val >= 0 && val <= 100);
return isInRange;
}
```
Even better:
```js
function isPercentage(val) {
return val >= 0 && val <= 100;
}
```
### Name your closures
Feel free to give your closures a name. It shows that you care about them, and
will produce better stack traces, heap and cpu profiles.
*Right:*
```js
req.on('end', function onEnd() {
console.log('winning');
});
```
*Wrong:*
```js
req.on('end', function() {
console.log('losing');
});
```
### No nested closures
Use closures, but don't nest them. Otherwise your code will become a mess.
*Right:*
```js
setTimeout(function() {
client.connect(afterConnect);
}, 1000);
function afterConnect() {
console.log('winning');
}
```
*Wrong:*
```js
setTimeout(function() {
client.connect(function() {
console.log('losing');
});
}, 1000);
```
### Method chaining
One method per line should be used if you want to chain methods.
*Right:*
```js
User
.findOne({ name: 'foo' })
.populate('bar')
.exec(function(err, user) {
return true;
});
```
*Wrong:*
```js
User
.findOne({ name: 'foo' })
.populate('bar')
.exec(function(err, user) {
return true;
});
User.findOne({ name: 'foo' })
.populate('bar')
.exec(function(err, user) {
return true;
});
User.findOne({ name: 'foo' }).populate('bar')
.exec(function(err, user) {
return true;
});
User.findOne({ name: 'foo' }).populate('bar')
.exec(function(err, user) {
return true;
});
```
## Comments
### Use slashes for comments
Use slashes for both single line and multi line comments. Try to write
comments that explain higher level mechanisms or clarify difficult
segments of your code. Don't use comments to restate trivial things.
*Right:*
```js
// 'ID_SOMETHING=VALUE' -> ['ID_SOMETHING=VALUE', 'SOMETHING', 'VALUE']
var matches = item.match(/ID_([^\n]+)=([^\n]+)/));
// This function has a nasty side effect where a failure to increment a
// redis counter used for statistics will cause an exception. This needs
// to be fixed in a later iteration.
function loadUser(id, cb) {
// ...
}
var isSessionValid = (session.expires < Date.now());
if (isSessionValid) {
// ...
}
```
*Wrong:*
```js
// Execute a regex
var matches = item.match(/ID_([^\n]+)=([^\n]+)/);
// Usage: loadUser(5, function() { ... })
function loadUser(id, cb) {
// ...
}
// Check if the session is valid
var isSessionValid = (session.expires < Date.now());
// If the session is valid
if (isSessionValid) {
// ...
}
```
## Miscellaneous
### Object.freeze, Object.preventExtensions, Object.seal, with, eval
Crazy shit that you will probably never need. Stay away from it.
### Requires At Top
Always put requires at top of file to clearly illustrate a file's dependencies.
Besides giving an overview for others at a quick glance of dependencies and
possible memory impact, it allows one to determine if they need a package.json
file should they choose to use the file elsewhere.
### Getters and setters
Do not use setters, they cause more problems for people who try to use your
software than they can solve.
Feel free to use getters that are free from [side effects][sideeffect], like
providing a length property for a collection class.
[sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science)
### Do not extend built-in prototypes
Do not extend the prototype of native JavaScript objects. Your future self will
be forever grateful.
*Right:*
```js
var a = [];
if (!a.length) {
console.log('winning');
}
```
*Wrong:*
```js
Array.prototype.empty = function() {
return !this.length;
}
var a = [];
if (a.empty()) {
console.log('losing');
}
```
# Style Guide License
This guide was created by [Felix Geisendörfer](http://felixge.de/) and is
licensed under the [CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/)
license. It was modified to match the code style required for this project.
![Creative Commons License](http://i.creativecommons.org/l/by-sa/3.0/88x31.png)

2
package.json
View File

@ -32,7 +32,7 @@
"transform-class-properties"
]
},
"author": "",
"author": "Jerko Steiner",
"license": "MIT",
"dependencies": {
"bluebird": "3.3.4",