extern/naming-cheatsheet
1
0
Fork 1
mirror of https://github.com/kettanaito/naming-cheatsheet.git synced 2025-08-09 06:45:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Artem Zakharchenko
2017-08-15 11:41:34 +02:00
committed by GitHub
parent e60f2e3f08
commit e394d5fc66
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,5 +1,5 @@
# Naming cheatsheet # Naming cheatsheet
Naming things is hard. Is it? Naming things is hard. Let's make it easier.
## Guidelines ## Guidelines
* Pick **one** naming convention and follow it. Whether it is `likeThis`, or `like_this`, or anyhow else, it does not matter. What matters is consistency in your work. * Pick **one** naming convention and follow it. Whether it is `likeThis`, or `like_this`, or anyhow else, it does not matter. What matters is consistency in your work.
@ -78,7 +78,7 @@ Chosing proper action name may grant explicit descriptiveness to your methods. T
Access data immediately (i.e. shorthand getter of internal data). Access data immediately (i.e. shorthand getter of internal data).
```js ```js
function getFruitsCount() { function getFruitsCount() {
return this.fruits; return this.fruits.length;
} }
``` ```
#### `fetch` #### `fetch`
@ -129,10 +129,10 @@ function removeFilter(filterName) {
``` ```
#### `delete` #### `delete`
Completely eraze something. For example, when you confirm "Are you sure you want to delete this post?", you perform `deletePost`, not `removePost`. Completely eraze something from the realms of existance. Imagine you are a blog writer, and you decide to delete one of your posts from the CMS. Once you pressed a shiny "Delete" button you would confirm "Are you sure you want to delete this post?". When you do, you would perform `deletePost` action, not `removePost`.
#### `compose` #### `compose`
Create new data from the existing one. Probably, applicable mostly to strings. Create a new data from the existing one. Probably, applicable mostly to strings.
```js ```js
function composePageUrl(pageName, pageId) { function composePageUrl(pageName, pageId) {
return `${pageName.toLowerCase()}-${pageId}`; return `${pageName.toLowerCase()}-${pageId}`;
@ -154,7 +154,7 @@ link.addEventListener('click', handleLinkClick);
Prefixes enhance variables or methods, indicating additional meaning behind them. Prefixes enhance variables or methods, indicating additional meaning behind them.
#### `is` #### `is`
Describes certain characteristic or state of the context. Describes certain characteristic or state of the current context.
```js ```js
const color = 'blue'; const color = 'blue';
const isBlue = (color === 'blue'); // characteristic const isBlue = (color === 'blue'); // characteristic
@ -166,7 +166,7 @@ if (isBlue && !isRemoved) {
``` ```
#### `min`/`max` #### `min`/`max`
Represent minimum or maximum value. Usually describe allowed limits. Represent minimum or maximum value. Handy when describing boundaries or allowed limits.
```js ```js
function PostsList() { function PostsList() {
this.minPosts = 3; this.minPosts = 3;