This file ( 4kB ) exceeds the allowed full mode (48 kb) size.
The editor full hight is disabled, only scrolling is allowed..
If you wish to edit a file, it is recommended to use the scroll mode as some users do not like the full height
mode, although some users like it.
artifacts/readme/code-style.md
[//]: #@corifeus-header
[](https://travis-ci.org/patrikx3/corifeus) [](https://scrutinizer-ci.com/g/patrikx3/corifeus/?branch=master) [](https://scrutinizer-ci.com/g/patrikx3/corifeus/?branch=master)
---
# Corifeus Matrix
## Issues / Support
This is an open source project. Time is a precious thing, so I have rarely time to give support and fix issues for someone else. I fix a bug, when I have an error that I need. If you got an issue, error or bug, I hope someone will have time to do it for you, otherwise, you are on your own.
Though, if I know the solution, I will tell you. Besides, core errors will be fixed by me.
***If you want to extend, fix bugs or add in new features, I promptly merge pull requests or you can become a ```patrikx3``` member.***
### Node Version Requirement
```
>=7.8.0
```
### Built on Node
```
v7.10.0
```
The ```async``` and ```await``` keywords are required.
Install NodeJs:
https://nodejs.org/en/download/package-manager/
# Description
[//]: #@corifeus-header:end
# Code style
```kabeb-case = meaning-only-lower-case-and-a-z-and-dash-and-numbers```
```PascalCase = JustAlphaAndAlwaysCapitalWords```
```camelCase = theFirstIsSmallTheRestIsCapital```
## CSS Prefix
``` kabeb-case ```
**Prefix so that get away form namespace clashes.**
```.cory = corifeus```
```css
.cory-something { font-family: "Corifeus"; }
```
## HTML Prefix
``` kabeb-case ```
**Prefix so that get away form namespace clashes.** It is both for tags and attributes.
``cory = corifeus``
```html
<cory-element cory-attribute="kabeb-case" class="cory-something"/>
```
## Url
``` kabeb-case ```
```bash
https://localhost/very-long-sentance/is/just/kebab-case.html
```
## Path
``` kabeb-case ```
```bash
/module-one/love/live/path.js
/try/code-style/by/class.js
```
## Filename
``` kabeb-case ```
```bash
// function
camel-case.js
// class
pascal-case-is-kebab-as-well.js
// html file
kabeb-case.html
// regular file
kebab-case.any
kabeb-case.js
kabeb-case.pdf
kabeb-case.html
kabeb-case.css
```
## Namespace
``` camelCase ```
The namespace = ```corifeus```
```javascript
// JavaScript
global.corifeus.camelCase = () => console.log('camelCase');
global.corifeus.camelCase = class camelCaseClass {};
```
## Variables
``` camelCase ```
```javascript
// JavaScript
const variableIsCool = 'camelCase';
let anotherVariable = false;
var oldTypeVariable = 'cool';
```
## Functions
``` camelCase ```
```javascript
// JavaScript
function justSimpleFunction() {
console.log('alsoCamelCase')
}
```
## Prototype based class
``` camelCase ```
```javascript
// JavaScript
function prototypeBasedClass() {
console.log('likeAClassIsCamelCase');
}
prototypeBasedClass.staticFunction = function() {}
prototypeBasedClass.staticVariable = true;
prototypeBasedClass.prototype.instanceFunction = function() {}
prototypeBasedClass.prototype.instanceVariable = true;
```
## Classes
``` camelCase ```
```javascript
// JavaScript
class simpleClass {
constructor() {}
instanceFunctionCamelCase() {}
get instanceProperty() { return true; }
set instanceProperty(value) { this._instanceProperty = value; }
static classMethod() { console.log('PascalCase'); }
static get classProperty() { return 'PascalCase'; }
}
```
## Objects
``` camelCase ```
```javascript
// JavaScript
const objects = {
variableNow: camelCase,
methodName: camelCase,
NameOfTheClass: PascalCase,
staticFuncitonName: camelCase.static,
instance: camelCase.variable
}
```
[//]: #@corifeus-footer
---
[**CORIFEUS**](https://pages.corifeus.tk/corifeus) Build v1.0.1268-11
[Corifeus](http://www.corifeus.tk) by [Patrik Laszlo](http://patrikx3.tk)
[//]: #@corifeus-footer:end