khalyomede / code-convention

Code conventions from my developper experience, gathered to remind me some best practice to keep the code scalable.

Code convention

Set of guidelines I built from my developper experience. Gathered here to remind me how to keep my code scalable over time.

Summary

• Function naming
• Variable naming

Function naming

• Function updating a boolean property
• Function returning the value of a boolean property
• Function returning an array
• Function checking if has element
• Function removing an element
• Function removing multiple elements

Function updating a boolean property

• Use kebab case
• Prefixed by enable or disable keywords to update a boolean value

class Response {
	static enableFetchingFromCache() {
		Response.fetchFromCache = true;
	}

	static disableFetchingFromCache() {
		Response.fetchFromCache = false;
	}
}

Function returning the value of a boolean property

• Use kebab case
• Name is positive
• Suffixed by enabled

class Response {
	static fetchingFromCacheEnabled() {
		return Response.fetchFromCache === true;
	}
}

Function returning an array

• Use kebab case
• Prefixed by get
• Plural

const Router {
    static _routes = [];

    static getRoutes() {
        return Router._routes;
    }
}

Function checking if has element

• Use kebab case
• Name positive
• Prefixed by has

class Router {
	static _routes = [];

	static hasRoute(route) {
		return Router._routes.includes(route);
	}
}

Function removing an element

• Use kebab case
• Singular naming
• Prefixed with remove

function removeNotification() {}

Function removing multiple elements

• Use kebab case
• Plural naming
• Prefixed with remove

function removeImages() {}

If the subject is not pluralizable, suffix it with list:

function removeFluxList() {}

Variable naming

• Arrays
• Booleans
• Looping on an array
• Number of items in an array

Array

• Use kebab case
• Plural

const repositories = ["rs-json", "browser-worker", "JUR"];

• If not pluralizable, suffix it by list

const fluxList = ["incoming", "outgoing"];

Booleans

• Use kebab case
• Name positive

class Response {
	static fetchFromCache = true;
}

Looping on an array

• Use kebab case
• for ... of or foreach ... as variable loop should have singular form

const buttons = document.querySelectorAll("button");

for (const button of buttons) {
	// ...
}

• regular for index name should be named index

for (let index = 0; index < 5; index++) {
	// ...
}

Number of items in an array

• Use kebab case
• Suffixed with count

const languages = ["php", "c#", "nodejs"];
const languagesCount = languages.length;